Spring、Mapper、Swagger常用注解

Spring注解
注解 说明
@Bean 就是一个已经实例化好的类
@Autowired 可以用在字段、set 方法或构造方法上,它可以自动注入 Spring 容器中存在的 Bean。
@Qualifier 和@Autowired 配套使用,主要用于解决 Bean 注入父类相同引起冲突的问题。@Autowired @Qualifier(“bean1”)
@Configuration 实际上这个注解有点等同于 @Component ,但是更多的是一种设计上的规范。通常在配置类上使用 @Configuration 注解而不是 @Component 注解。
@Bean 该注解使用在方法上,该方法返回的 Bean 会存到 Spring 容器中。
@Value 该注解用在字段、方法的参数和构造方法的参数上,你可以通过 @Value 来申明默认的值,你也可以通过它来获取配置文件( application.properties )中的值,例如 @Value("#{dataSource.url}") 这样。
@Component 有此注解的类 Spring 会自动把这个类实例化放入容器。
@Controller 配合 @RequestMapping 注解使用,声明该类为 Spring 的 Controller,
@Service 申明该类主要负责业务逻辑,例如注册验证存储逻辑。
@Repository 申明该类为持久层,用于处理与数据库的 CRUD 操作,类似于 DAO。
@ControllerAdvice 申明该类用于处理 Controller 层抛出的异常,大家可以在里面自定义异常的处理流程。
@RestController 申明为 REST 版的控制器,在这个类中返回的内容 Spring 会通过 Jackson 自动转换为 json 格式。
@RestControllerAdvice 与 @RestController 类似,是 @ControllerAdvice 的 rest 版。
@Transactional 事务注解,如果里面的 SQL 操作出现异常,会自动进行回滚。
Mapper注解
注解 说明
@Results 多个 @Result 的集合,可以表示与数据库某个表的整体映射关系,其中它的 id 可供 @ResultMap 使用。详情可以看上方的代码。
@Result 表中某字段与实体类某个字段的对应关系。
@Insert 对应 SQL 的 insert 操作。
@Delete 对应 SQL 的 delete 操作。
@Update 对应 SQL 的 update 操作。
@Select 对应 SQL 的 select 操作,通常与 @ResultMap 配合使用。
@ResultMap 确定本 SQL 语句与实体类的对应关系,其中 map id 需要事先通过 @Results 声明对应关系,详情见上面的代码。
@Param 让变量替换掉 SQL 语句中的 #{xxx},例如 @Param(“username”) String data ,假设 data 的值为 smith 。 @Param 注解可以把 SQL 语句由 SELECT * FROM user WHERE username=#{username} 变为 SELECT * FROM user WHERE username=‘smith’ 。
Swagger注解
注解 说明
@Api 用在请求的类上,表示对类的说明,也代表了这个类会出现在 Swagger 上
@ApiOperation 用在方法上,表示一个 http 请求访问该方法的操作
@ApiModel 用于响应实体类上,用于说明实体作用
@ApiImplicitParams @ApilmplicitParam 的集合
@ApilmplicitParam 用在方法上,指定某个请求参数的内容
@ApiIgnore 用在类或方法上,标明忽略此接口

你可能感兴趣的:(项目,Java,spring,mybatis,java)