目录
- Spring注解
- SpringMVC注解
- @Controller 声明该类为SpringMVC中的Controller
- @RequestMapping 用于映射Web请求,包括访问路径和参数(类或方法上)
- @Autowired: 实现自动装配功能的注解
- @ModelAttribute
- @PathVariable
- @RequestHeader 用于获取请求消息头。
- @RequestBody 读取Request请求的body数据
- @RequestParam
- @ResponseBody 支持将返回值放在response内,而不是一个页面,通常用户返回json数据(返回值旁或方法上)
- @CookieValue 用于把指定 cookie 名称的值传入控制器方法参数。
- @SessionAttributes即将值放到session作用域中,写在class上面。
- @RestController 相当于@Controller和@ResponseBody的组合
- @ControllerAdvice
- @Component
- @Repository
- @EnableWebMvc 在配置类中开启Web
- SpringBoot注解
- 注解详解
- @SpringBootApplication
- @SpringBootConfiguration
- @ResponseBody:
- @Controller:
- @RestController
- @RequestMapping
- @EnableAutoConfiguration
- @ComponentScan
- @Configuration
- @Import
- @ImportResource
- @Autowired
- @Service
- @Repository
- @Bean
- @Value
- @Inject
- @Component
- @Bean
- @AutoWired
- @Qualifier
- @Resource(name=”name”,type=”type”)
- @JsonBackReference
- @RepositoryRestResourcepublic
- JPA注解
- @Entity:@Table(name=”“)
- @MappedSuperClass
- @NoRepositoryBean
- @Column
- @Id
- @GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)
- @SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)
- @Transient
- @JsonIgnore
- @JoinColumn(name=”loginId”)
- @OneToOne、@OneToMany、@ManyToOne
- 全局异常处理
- 项目中具体配置解析和使用环境
- 注解详解
- SpringCloud注解
Spring注解
Spring 原始注解主要是替代<Bean>的配置
注解 | 说明 |
---|---|
@Component | 使用在类上用于实例化Bean |
@Controller | 使用在web层类上用于实例化Bean |
@Service | 使用在service层类上用于实例化Bean |
@Repository | 使用在dao层类上用于实例化Bean |
@Autowired | 使用在字段上用于根据类型依赖注入,在@Autowired注解中有个属性required,默认值为true,要求必须完成自动装配,可以将required设置为false,此时能装配则装配,无法装配则使用属性的默认值。 |
@Qualifier | 结合@Autowired一起使用用于根据名称进行依赖注入 |
@Resource | 相当于@Autowired+@Qualifier,按照名称进行注入 |
@Value | 注入普通属性 |
@Scope | 标注Bean的作用范围 |
@PostConstruct | 使用在方法上标注该方法是Bean的初始化方法 |
@PreDestroy | 使用在方法上标注该方法是Bean的销毁方法 |
@Configuration | 用于指定当前类是一个 Spring 配置类,当创建容器时会从该类上加载注解 |
@ComponentScan | 用于指定 Spring 在初始化容器时要扫描的包。 作用和在 Spring 的 xml 配置文件中的 <context:component-scan base-package="com.itheima"/>一样 |
@Bean | 使用在方法上,标注将该方法的返回值存储到 Spring 容器中 |
@PropertySource | 用于加载.properties 文件中的配置 |
@ConfigurationProperties | @ConfigurationProperties 主要作用就是将prefix 属性指定的前缀配置项的值绑定到这个Bean上,默认情况下需要和@Component 或者@Configuration 一起使用才能生效. |
@Import | 用于导入其他配置类 |
@Required | 表明 bean 的属性必须在配置的时候设置,通过一个 bean 定义的显式的属性值或通过自动装配,若 @Required 注解的 bean 属性未被设置,容器将抛出 BeanInitializationException。 |
声明bean的注解
声明 bean 的注解有四个,不过功能都差不多,只要记住一个也可以
下面讲解其四个的区别
一开始要在xml中配置扫描注解的组件
扫描被注解的类
<context:component-scanbase-package=”XXX”/>
- @Component 组件,没有明确的角色
- @Service 在业务逻辑层使用(service层)
- @Repository 在数据访问层使用(dao层)
- @Controller 在展现层使用,控制器的声明
注入bean的注解
主要有@Autowired、@Qualifier、@Resource以及@Value这四个
下面以代码的方式讲解其不同之处
接口实现类
@Repository(value = "userDaoImpl1")
public class UserDaoImpl implements UserDao {
@Override
public void add() {
System.out.println("dao add.....");
}
}
- @Autowired:由Spring提供,根据类型进行自动装配,如果组合@Qualifier使用将按名称进行装配```java
@Autowired //根据类型进行注入
private UserDao userDao;
- @Qualifier(value=" "):根据属性名称自动注入
@Autowired //根据类型进行注入
@Qualifier(value = "userDaoImpl1") //根据名称进行注入
private UserDao userDao;
- @Resource:由JSR-250提供,使用需要导入javax.annotation,根据名称进行自动装配的,一般会指定一个name属性
@Resource(name = "userDaoImpl1") //根据名称进行注入
private UserDao userDao;
- @Inject:由JSR-330提供使用时需要导入javax.inject.Inject;实现注入同样是根据类型进行自动装配,如果需要按名称进行装配,则需要配合@Named
- @Value:注入普通类型的注入
注解不是对象类型的定义,可以是字符串等其他
@Value(value = "abc")
private String name;
配置类注解
@Configuration
- @Configuration 声明当前类为配置类,相当于xml形式的Spring配置(类上)
- @Configuration 声明当前类为配置类,其中内部组合了@Component注解,表明这个类是一个bean(类上)
@Bean
- @Bean 注解在方法上,声明当前方法的返回值为一个bean,替代xml中的方式(方法上)
@ComponentScan
- @ComponentScan 用于对Component进行扫描,相当于xml中的(类上)
@WishlyConfiguration
- @WishlyConfiguration 为@Configuration与@ComponentScan的组合注解,可以替代这两个注解
功能注解
- @Transactional声明事务
- @Cacheable声明缓存
配置类相关注解
- @Configuration 声明当前类为配置类
- @Bean 注解在方法上,声明当前方法的返回值为一个bean
- @ComponentScan 用于对Component进行扫描,
- @WishlyConfiguration 为@Configuration与@ComponentScan的组合注解,可以替代这两个注解
切面(AOP)相关注解
- @Aspect 声明一个切面
- @After 在方法执行之后执行(方法上)
- @Before 在方法执行之前执行(方法上)
- @Around 在方法执行之前与之后都执行(方法上)
- @PointCut 声明切点
- @Bean的属性支持
- @Scope设置Spring新建Bean的类型,可选择包括:
- Singleton 单例,一个Spring容器中只有一个bean实例,默认模式
- Protetype 每次调用新建一个bean
- Request web项目中,给每个http request新建一个bean
- Session web项目中,给每个http session新建一个bean
- GlobalSession(给每一个 global http session新建一个Bean实例
- @StepScope 在Spring Batch中还有涉及
- @PostConstruct 由JSR-250提供,在构造函数执行完之后执行,等价于xml配置文件中bean的 initMethod
- @PreDestory 由JSR-250提供,在Bean销毁之前执行,等价于xml配置文件中bean的destroyMethod
- @Scope设置Spring新建Bean的类型,可选择包括:
校验检查
全部参数校验如下:
空检查
- @Null 验证对象是否为null
- @NotNull 验证对象是否不为null, 无法查检长度为0的字符串
- @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
- @NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
- @AssertTrue 验证 Boolean 对象是否为 true
- @AssertFalse 验证 Boolean 对象是否为 false
长度检查
- @Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
- @Length(min=, max=)验证注解的元素值长度在min和max区间内
日期检查
- @Past 验证 Date 和 Calendar 对象是否在当前时间之前
- @Future 验证 Date 和 Calendar 对象是否在当前时间之后
- @Pattern 验证 String 对象是否符合正则表达式的规则
数值检查
建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为”“,Integer为null
- @Min(value=””) 验证 Number 和 String 对象是否大等于指定的值
- @Max(value=””) 验证 Number 和 String 对象是否小等于指定的值
- @DecimalMax(value=值) 被标注的值必须不大于约束中指定的最大值.
这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 - @DecimalMin(value=值) 被标注的值必须不小于约束中指定的最小值.
这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 - @Digits 验证 Number 和 String 的构成是否合法
- @Digits(integer=,fraction=)验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
- @Range(min=, max=) 检查数字是否介于min和max之间.
- @Range(min=10000,max=50000,message=”range.bean.wage”)
private BigDecimal wage; - @Valid 递归的对关联对象进行校验,
如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) - @CreditCardNumber信用卡验证
- @Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
- @ScriptAssert(lang=,script=, alias=)
- @URL(protocol=,host=,port=,regexp=, flags=)
- @Validated
- @Valid是对javabean的校验,如果想对使用@RequestParam方式接收参数方式校验使用@Validated
类生命周期注解
- @PostConstruct 由JSR-250提供,在类的构造函数执行完之后执行,等价于xml配置文件中bean的initMethod
- @PreDestory 由JSR-250提供,在Bean销毁之前执行
配置注入
@Value为属性注入值,支持如下方式的注入:
- 普通字符@Value(“Michael Jackson”)
- 操作系统属性@Value("#{systemProperties[‘os.name’]}")
- 表达式结果@Value("#{ T(java.lang.Math).random() * 100 }")
- 其它bean属性@Value("#{domeClass.name}")
- 文件资源@Value(“classpath:cn/shiyujun/test.txt”)
- 网站资源@Value(“https://shiyujun.cn”)
- 配置文件属性@Value("${book.name}")
@PropertySource
@PropertySource注入配置文件(“classpath:cn/shiyujun/test.propertie”)
环境切换
- Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境
- @Conditional根据代码中设置的条件装载不同的bean,包括一系列的注解
- @ConditionalOnBean存在bean
- @ConditionalOnMissingBean不存在bean
- @ConditionalOnClass存在某个类
- @ConditionalOnMissingClass不存在某个类
- @ConditionalOnProperty(prefix = “syj”, name = “algorithm”, havingValue = “token”)当存在配置文件中以syj为前缀的属性,属性名称为algorithm,然后它的值为token时才会实例化一个类。
- @ConditionalOnProperty(prefix = “syj”, name = “algorithm”, havingValue = “counter”, matchIfMissing = true)如果所有的都不满足的话就选择counter为默认实现
- @ConditionalOnJava如果是Java应用
- @ConditionalOnWebApplication如果是Web应用
异步相关
- @Async 在实际执行的bean方法使用该注解来申明其是一个异步任务
- 注意:需要在启动类加入 @EnableAsync 使异步调用 @Async 注解生效。
定时任务相关
- @Scheduled 来申明这是一个任务,包括cron,fixDelay,fixRate等类型
开启某些功能
- @EnableAspectJAutoProxy 开启对AspectJ自动代理的支持
- @EnableAsync 开启异步方法的支持
- @EnableScheduling 开启计划任务的支持
- @EnableWebMvc 开启Web MVC的配置支持
- @EnableConfigurationProperties 开启对@ConfigurationProperties注解配置Bean的支持
- @EnableJpaRepositories 开启对SpringData JPA Repository的支持
- @EnableTransactionManagement 开启注解式事务的支持
- @EnableCaching 开启注解式的缓存支持
测试相关注解
- @RunWith Spring中通常用于对JUnit的支持
- @ContextConfiguration 用来加载配置ApplicationContext
@ConfigurationProperties
@ConfigurationProperties
主要作用就是将prefix
属性指定的前缀配置项的值绑定到这个 Bean 上,默认情况下需要和@Component
或者@Configuration
一起使用才能生效。
使用方法
- 使用在类上
- 使用在方法上
属性
value 和 prefix 功能相同,比较容易理解就是将指定的前缀属性绑定到这个 Bean 上的属性。
ignoreInvalidFields:默认 false 表示绑定到此对象时应忽略无效字段。指示绑定到此对象时应忽略无效字段。一般是字段类型错误(或无法强制转换为正确类型),例如:实体类中定义的可能是一个 Boolean 类型,但是配置项的值却是日期。则这个时候会报错。
ignoreUnknownFields: 默认 true,表示绑定到此对象时应忽略实体类中不存在的字段。例如配置项中可能有一个同样前缀的配置,但是实体类中没有对应的属性。
总结
- @ConfigurationProperties 和 @value 有着相同的功能,但是 @ConfigurationProperties 的写法更为方便
- @ConfigurationProperties 的 POJO 类的命名比较严格,因为它必须和 prefix 的后缀名要一致, 不然值会绑定不上, 特殊的后缀名是“driver-class-name”这种带横杠的情况,在 POJO 里面的命名规则是 下划线转驼峰 就可以绑定成功,所以就是 “driverClassName”
SpringMVC注解
@Controller 声明该类为SpringMVC中的Controller
@Controller 用于标记在一个类上,使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法,并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类,而使用@RequestMapping 注解的方法才是真正处理请求的处理器
@RequestMapping 用于映射Web请求,包括访问路径和参数(类或方法上)
@RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
属性:
value:用于指定请求的 URL。它和 path 属性的作用是一样的。
method:用于指定请求的方式。
params:用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的 key 和 value 必须和配置的一模一样。
headers:用于指定限制请求消息头的条件。
@Autowired: 实现自动装配功能的注解
@Autowired做bean的注入时使用,可以写在字段和setter方法上。如果都写在字段上,那么就不需要再写setter方法。
@Autowired注解能够标识的位置
- 标识在成员变量上,此时不需要设置成员变量的set方法
- 标识在set方法上
- 标识在为当前成员变量赋值的有参构造上
@Autowired注解的原理
- 默认通过byType的方式,在IOC容器中通过类型匹配某个bean为属性赋值
- 若有多个类型匹配的bean,此时会自动转换为byName的方式实现自动装配的效果,即将要赋值的属性的属性名作为bean的id匹配某个bean为属性赋值
- 若byType和byName的方式都无妨实现自动装配,即IOC容器中有多个类型匹配的bean,且这些bean的id和要赋值的属性的属性名都不一致,此时抛异常:NoUniqueBeanDefinitionException
- 此时可以在要赋值的属性上,添加一个注解@Qualifier通过该注解的value属性值,指定某个bean的id,将这个bean为属性赋值
- 注意:若IOC容器中没有任何一个类型匹配的bean,此时抛出异常:NoSuchBeanDefinitionException
- 在@Autowired注解中有个属性required,默认值为true,要求必须完成自动装配,可以将required设置为false,此时能装配则装配,无法装配则使用属性的默认值
@ModelAttribute
出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。
它可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。
出现在参数上,获取指定的数据给参数赋值。
本来的作用是绑定键值对到Model里,在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。
该Controller的所有方法在调用前,先执行此@ModelAttribute方法,可用于注解和方法参数中,即可实现在调用Controller时,先执行@ModelAttribute方法。
属性:
value:用于获取数据的 key。
key 可以是 POJO 的属性名称,也可以是 map 结构的 key。
@PathVariable
@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上,即取出URL模板中的变量作为参数
属性:
value:用于指定 url 中占位符名称。
required:是否必须提供占位符。
@RequestHeader 用于获取请求消息头。
属性:
value:提供消息头名称
required:是否必须有此消息头
@RequestBody 读取Request请求的body数据
@RequestBody的作用
@RequestBody用于读取Request请求的body数据,然后利用SpringMVC配置的HttpMessageConverter对数据进行转换,最后把转换后的数据绑定到被@RequestBody注解的参数上;
@RequestBody的使用场景
根据request header中 Content-Type和被@RequestBody注解的参数不同,最常见的应用场景如下:
- Content-Type为application/json
- 参数为JavaBean:可实现json反序列化为JavaBean,使用的HttpMessageConverter为 MappingJackson2HttpMessageConverter
- 参数为String:简单将字符串赋值给参数,使用的HttpMessageConverter为 StringHttpMessageConverter
- Content-Type为application/xml**
- 参数为JavaBean:可实现xml反序列化为JavaBean,使用的HttpMessageConverter为 Jaxb2RootElementHttpMessageConverter
- 参数为String:简单将字符串赋值给参数,使用的HttpMessageConverter为 StringHttpMessageConverter
- application/x-www-form-urlencoded
- 参数为String:简单将字符串赋值给参数,使用的HttpMessageConverter为 StringHttpMessageConverter
注意
- 在一个方法的参数列表中,@RequestBody只能使用一次;
- json字符串中,如果value为""的话,后端对应属性如果是String类型的,那么接受到的就是"",如果是后端属性的类型是Integer、Double等类型,那么接收到的就是null;
- json字符串中,如果value为null的话,后端对应收到的就是null;
- 在传json字符串给后端时,如果某个key没有value的话,要么干脆就不写该key,要么就将value赋值null 或"",不能有类似 {......,"key":,.....}, 这样的写法
@RequestParam
@RequestParam主要用于在SpringMVC后台控制层获取参数,类似一种是Request.getParameter(“name”)
属性:
value:请求参数中的名称。
required:请求参数中是否必须提供此参数。默认值:true。表示必须提供,如果不提供将报错。
@ResponseBody 支持将返回值放在response内,而不是一个页面,通常用户返回json数据(返回值旁或方法上)
@ResponseBody该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。
使用:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;
属性:
required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false,get 请求得到是 null。
@CookieValue 用于把指定 cookie 名称的值传入控制器方法参数。
属性:
value:指定 cookie 的名称。
required:是否必须有此 cookie。
@SessionAttributes即将值放到session作用域中,写在class上面。
属性:
value:用于指定存入的属性名称
type:用于指定存入的数据类型。
@RestController 相当于@Controller和@ResponseBody的组合
该注解为一个组合注解,相当于@Controller和@ResponseBody的组合,注解在类上,意味着,该Controller的所有方法都默认加上了@ResponseBody。
@ControllerAdvice
作用:
1、全局异常处理
2、全局数据绑定
3、全局数据预处理
通过该注解,我们可以将对于控制器的全局配置放置在同一个位置,注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上,
这对所有注解了 @RequestMapping的控制器内的方法有效。
@ExceptionHandler 用于全局处理控制器里的异常
@InitBinder 用来设置WebDataBinder,WebDataBinder用来自动绑定前台请求参数到Model中
@Component
相当于通用的注解,当不知道一些类归到哪个层时使用,但是不建议。
@Repository
用于注解dao层,在dao实现类上面注解。为 DAO 提供了额外的好处。它将 DAO 导入 IOC 容器,并使未经检查的异常有资格转换为 Spring DataAccessException。
@EnableWebMvc 在配置类中开启Web
MVC的配置支持,如一些ViewResolver或者MessageConverter等,若无此句,重写WebMvcConfigurerAdapter方法(用于对SpringMVC的配置)。
SpringBoot注解
注解详解
@SpringBootApplication
申明让spring boot自动给程序进行必要的配置,这个配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。
@SpringBootConfiguration
@SpringBootConfiguration 继承自 @Configuration,二者功能也一致,标注当前类是配置类,并会将当前类内声明的一个或多个以 @Bean 注解标记的方法的实例纳入到 spring 容器中,并且实例名就是方法名。
组合了 @Configuration 注解,实现配置文件的功能。
@ResponseBody:
表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用@RequestMapping后,返回值通常解析为跳转路径,加上@esponsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@Responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。
@Controller:
用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解@RequestMapping。
@RestController
用于标注控制层组件(如 struts 中的 action ),@Controller 和 @ResponseBody 的合集
表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。
@RequestMapping
提供路由信息,负责URL到Controller中的具体函数的映射。
@EnableAutoConfiguration
自动配置
SpringBoot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。
@ComponentScan
组件扫描,可自动发现和装配一些Bean。
@Component可配合CommandLineRunner使用,在程序启动后执行一些基础任务。
让spring Boot扫描到Configuration类并把它加入到程序上下文。
表示将该类自动发现扫描组件。个人理解相当于,如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。
@Configuration
相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。
@Import
用来导入其他配置类。
@ImportResource
用来加载xml配置文件。
@Autowired
自动导入依赖的bean
@Service
一般用于修饰service层的组件
@Repository
使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
@Bean
用@Bean标注方法等价于XML中配置的bean。
@Value
注入Spring boot application.properties配置的属性的值。示例代码:
@Inject
等价于默认的@Autowired,只是没有required属性;
@Component
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@Bean
相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。
@AutoWired
自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。
@Qualifier
当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:
@Resource(name=”name”,type=”type”)
没有括号内内容的话,默认byName。与@Autowired干类似的事。
@Resource 默认是按照名称来装配注入的,只有当找不到与名称匹配的bean才会按照类型来装配注入。
@JsonBackReference
解决嵌套外链问题。
@RepositoryRestResourcepublic
配合spring-boot-starter-data-rest使用。
JPA注解
@Entity:@Table(name=”“)
表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略
@MappedSuperClass
用在确定是父类的entity上。父类的属性子类可以继承。
@NoRepositoryBean
一般用作父类的repository,有这个注解,spring不会去实例化该repository。
@Column
如果字段名与列名相同,则可以省略。
@Id
表示该属性为主键。
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)
表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq。
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)
name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。
@Transient
表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式
@JsonIgnore
作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。
@JoinColumn(name=”loginId”)
一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。
@OneToOne、@OneToMany、@ManyToOne
对应hibernate配置文件中的一对一,一对多,多对一。
全局异常处理
@ControllerAdvice
包含@Component。可以被扫描到。统一处理异常。
@ExceptionHandler(Exception.class)
用在方法上面表示遇到这个异常就执行以下方法。
项目中具体配置解析和使用环境
@MappedSuperclass:
- @MappedSuperclass 注解使用在父类上面,是用来标识父类的
- @MappedSuperclass 标识的类表示其不能映射到数据库表,因为其不是一个完整的实体类,但是它所拥有的属性能够映射在其子类对用的数据库表中
- @MappedSuperclass 标识的类不能再有@Entity或@Table注解
@Column:
- 当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明,该属性通常置于实体的属性声明语句之前,还可与 @Id 标注一起使用。
- @Column 标注的常用属性是name,用于设置映射数据库表的列名。此外,该标注还包含其它多个属性,如:unique、nullable、length、precision等。具体如下:
- name属性:name属性定义了被标注字段在数据库表中所对应字段的名称
- unique属性:unique属性表示该字段是否为唯一标识,默认为false,如果表中有一个字段需要唯一标识,则既可以使用该标记,也可以使用@Table注解中的@UniqueConstraint
- nullable属性:nullable属性表示该字段是否可以为null值,默认为true
- insertable属性:insertable属性表示在使用”INSERT”语句插入数据时,是否需要插入该字段的值
- updateable属性:updateable属性表示在使用”UPDATE”语句插入数据时,是否需要更新该字段的值
- insertable和updateable属性:一般多用于只读的属性,例如主键和外键等,这些字段通常是自动生成的
- columnDefinition属性:columnDefinition属性表示创建表时,该字段创建的SQL语句,一般用于通过Entity生成表定义时使用,如果数据库中表已经建好,该属性没有必要使用
- table属性:table属性定义了包含当前字段的表名
- length属性:length属性表示字段的长度,当字段的类型为varchar时,该属性才有效,默认为255个字符
- precision属性和scale属性:precision属性和scale属性一起表示精度,当字段类型为double时,precision表示数值的总长度,scale表示小数点所占的位数
具体如下:
1. double类型将在数据库中映射为double类型,precision和scale属性无效
2. double类型若在columnDefinition属性中指定数字类型为decimal并指定精度,则最终以columnDefinition为准
3. BigDecimal类型在数据库中映射为decimal类型,precision和scale属性有效
4. precision和scale属性只在BigDecimal类型中有效
- @Column 标注的columnDefinition属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型.
- @Column标注也可置于属性的getter方法之前
@Getter和@Setter(Lombok)
@Setter:注解在属性上;为属性提供 setting 方法
@Getter:注解在属性上;为属性提供 getting 方法
@Data:注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
@Log4j2 :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象,和@Log4j注解类似
@NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
@AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
@EqualsAndHashCode:默认情况下,会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法,也可以指定具体使用哪些属性。
@toString:生成toString方法,默认情况下,会输出类名、所有属性,属性会按照顺序输出,以逗号分割。
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor 分别为 无参构造器、部分参数构造器、全参构造器,当我们需要重载多个构造器的时候,只能自己手写了
@NonNull:注解在属性上,如果注解了,就必须不能为Null
@val: 注解在属性上,如果注解了,就是设置为final类型,可查看源码的注释知道
当你在执行各种持久化方法的时候,实体的状态会随之改变,状态的改变会引发不同的生命周期事件。这些事件可以使用不同的注释符来指示发生时的回调函数。
@javax.persistence.PostLoad:加载后。
@javax.persistence.PrePersist:持久化前。
@javax.persistence.PostPersist:持久化后。
@javax.persistence.PreUpdate:更新前。
@javax.persistence.PostUpdate:更新后。
@javax.persistence.PreRemove:删除前。
@javax.persistence.PostRemove:删除后。
@SpringBootTest
编写测试用例的注解
数据库
数据库查询
@PostLoad事件在下列情况下触发:
执行EntityManager.find()或getreference()方法载入一个实体后。
执行JPQL查询后。
EntityManager.refresh()方法被调用后。
数据库插入
@PrePersist和@PostPersist事件在实体对象插入到数据库的过程中发生:
@PrePersist事件在调用persist()方法后立刻发生,此时的数据还没有真正插入进数据库。
@PostPersist事件在数据已经插入进数据库后发生。
数据库更新
@PreUpdate和@PostUpdate事件的触发由更新实体引起:
@PreUpdate事件在实体的状态同步到数据库之前触发,此时的数据还没有真正更新到数据库。
@PostUpdate事件在实体的状态同步到数据库之后触发,同步在事务提交时发生。
数据库删除
@PreRemove和@PostRemove事件的触发由删除实体引起:
@PreRemove事件在实体从数据库删除之前触发,即在调用remove()方法删除时发生,此时的数据还没有真正从数据库中删除。
@PostRemove事件在实体从数据库中删除后触发。
SpringCloud注解
@EnableDiscoveryClient基于spring-cloud-commons,如果选用的注册中心是eureka,那么就推荐@EnableEurekaClient。
@EnableEurekaClient 基于spring-cloud-netflix,如果是其他的注册中心,那么推荐使用@EnableDiscoveryClient。
@EnableFeignClients 开启Spring Cloud Feign的支持
@FeignClient springboot调用外部接口:声明接口之后,在代码中通过@Resource注入之后即可使用。@FeignClient标签的常用属性如下:name:指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现
@EnableCircuitBreaker 开启断路器功能
@LoadBalanced 在使用 RestTemplate 的时候 如果 RestTemplate 上面有 这个注解,那么 这个 RestTemplate 调用的 远程地址,会走负载均衡器。
@RibbonClient,这个注解用来为负载均衡客户端做一些自定义的配置,可以进一步配置或自定义从哪里获取服务端列表、负载均衡策略、Ping也就是服务鉴活策略等等
@CrossOrigin 可以处理跨域请求,让你能访问不是一个域的文件;
@RefreshScope 如果代码中需要动态刷新配置,在需要的类上加上该注解就行。但某些复杂的注入场景下,这个注解使用不当,配置可能仍然不动态刷新;
@RepositoryRestResourcepublic 配合spring-boot-starter-data-rest使用