Spring boot中相关的注解
一、相关类中使用的注解
- @RestController:REST风格的控制器
- @RequestMapping:配置URL和方法之间的映射
- @SpringBootApplication:应用程序入口类
- @Controller:控制器
- @Service:业务处理类
- @Repository:数据库访问类
- @Configuration:配置类
- @Resource:装配bean
- @Autowired:注入对象
- @Qualifier:用于标注哪一个实现类才是需要注入的
- @Transaction:处理事务
- @ComponentScan:扫描组件(servlet、过滤器、监听器、bean等)
- @WebServlet:注册servlet
- @EnableAutoConfiguration:提供自动配置
- @EnableScheduling:开启计划任务
- @EnableAsync:开启异步
- @ControllerAdvice:同意处理异常
- @ConfigurationProperties:同类配置信息封装成一个实体类
- @Order:排序、序号越小越早执行
- @WebFilter:注册过滤器
- @WebListener:标注为监听类
- @Conditional :按照一定的条件进行判断,满足条件给容器注册bean
- @Profile :根据当前环境,动态的激活和切换一系列组件的功能
- @Import :导入配置类或者导入一个带有@Component等注解要放入Spring容器中的类
- @ImportResource :导入一个传统的xml配置文件
- @Bean :可以把第三方包的类对象放入到spring ioc中
- @Primary :修改优先权
- @PropertySource :加载指定的属性文件(*.properties)到 Spring 的 Environment 中。可以配合 @Value 和 @ConfigurationProperties 使用
- @MapperScan:可以指定要扫描的Mapper类的包的路径
- @Scrope:描述spring容器如何新建Bean实例
- Singleton:容器共享一个Bean实例,默认为Singleton
- Prototype:每次调用新建一个Bean
- Request:每一个request新建一个
- Session:每一个Session新建一个
- GlobalSession:只在portal应用中有用,每一个GlobalSession新建一个Bean
二、相关方法中使用的注解
- @RequestBody:将请求体中的字符串绑定到相应的对象上
- @PathVariable:获取路径中的参数
- @Bean:交给spring管理的对象
- @ResponseBody:用来返回json、xml格式的数据
- @ExceptionHandler:异常执行方法
- @RequestMapping:地址映射
- @GetMapping:查询的请求
- @PostMapping:新增的请求
- @DeleteMapping:删除的请求
- @PutMapping:修改的请求
- @RequestParam:将请求参数绑定到你控制器的方法参数上
- @PostConstruct:修饰一个非静态的void()方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行,并且只会被服务器执行一次。PostConstruct在构造函数之后执行,init()方法之前执行。
三、元注解(定义注解的注解)
- @Retention:注解的生命周期
- @Target:表明注解可以使用的范围
- @Inherited:表明类型是可以被继承的
- @Documented:将注解信息添加在java文档中
- @Interface:自定义注释类型
四、JUnit中的注解
- @BeforeClass:一般用来初始化整体代码
- @AfterClass:一般用来销毁和释放资源
- @Before:一般用来初始化方法
- @After:一般用来回滚测试数据
- @Test:编写测试用例
- @Ignore:测试时忽略
- @RunWith:负责调用测试代码
- @SpringBootTest:指定测试入口
五、MyBatis中的注解
- @Select:查询
- @Insert:添加
- @Update:修改
- @Delete:删除
- @Mapper:标注类交给spring管理
- @Results:结果集多个字段映射关系
- @Result:结果集单个字段映射关系
- @ResultMap:根据ID关联xml里面的<ResultMap>
- @SelectProvider:构建动态查询Sql
- @InsertProvider:构建动态添加Sql
- @UpdateProvider:构建动态更新Sql
- @DeleteProvider:构建动态删除Sql
六、Swagger中的注解
- @Api:描述接口用途
- @ApiOperation:描述方法用途
- @ApiImplicitParam:描述方法参数
- @ApiImplicitsParam:描述方法多个参数
- @ApiIgnore:忽略
七、Spring Cache中的注解
- @EnableCAche:开启缓存
- @CacheAble:缓存类和方法的返回值
- @CachePut:每次都会触发真实方法的调用
- @CacheEvict:标注需要清除缓存的方法和类
- @Caching:组合多个相关注解标签
八、AOP中的注解
- @Before:在切入点开始处切入内容
- @After:在切入点结尾处切入内容
- @Around:在切入点前后切入内容
- @Aspect:标记为切面类
- @Component:把切面类加入IoC容器中,让spring进行管理
- @AfterReturning:在切入点返回内容之后切入内容
- @AfterThrowing:切入内容部分,抛出异常之后的处理逻辑
九、Hibernate-validator注解(内置数据验证器)
- @NotBlank:非null,长度大于0
- @Email:邮箱
- @Length(min=,max=):字符串大小范围
- @NotEmpty:非空
- @NotEmptyPatten:非空情况下,是否匹配正则表达式
- @DateValidator:日期格式 是否满足正则表达式
- @DateFormatCheckPattern:日期格式 是否满足正则表达式
- @CreditCardNumber:信用卡号码
- @Range(min=,max=,message=):元素必须在合适范围内
- @Null:null
- @NotNull:不为null
- @AssertTrue:元素必须为true
- @AssertFalse:元素必须为false
- @Min(value):数字最小值
- @Max(value):数字最大值
- @DecimalMin(value):数字最小值
- @DecimalMax(value):数字最大值
- @Size(max=,min=):数字的范围
- @Ditits(integer,fraction):范围内数字
- @Past:过去的日期
十、Lombok注解
- @Data:自动生成Getter、Setter、toString、equals、hashCode方法,以及不带参数的构造方法
- @NonNull:帮助处理空指针异常
- @CleanUp:自动管理资源
- @Setter/@Getter:Getter、Setter方法
- @ToString:生成toString方法
- @EqualsAndHashcode:重写hashCode和equals方法
- @NoArgsConstructor/@RequiredArgsConstructor/@AllArgsConstructor:自动生成构造方法
- @Value:标注为final类
- @Builder:生成复杂的构造器API类
- @SneakyThrows:用于处理异常
- @Synchronized:同步方法的转换
- @Log:支持各种日志对象
十一、其他
- @EnableRedisHttpSession:开启Redis分布式Session支持
- @Value:获取配置文件中的值(用在属性上)
- Spring EL: spring表达式语言,可以用运算规则来装配Bean
- @EnableAsync:开启异步
- @Async:方法进行异步操作