Springboot常用注解

一、controller类

参数设置

• @RequestParam
  用于将指定的请求参数赋值给方法中的形参，用于url中的参数，对请求体中的参数无效。

三个属性：
（1）value：请求参数名（必须配置）
（2）required：是否必需，默认为 true，即 请求中必须包含该参数，如果没有包含，将会抛出异常（可选配置）
（3）defaultValue：默认值，如果设置了该值，required 将自动设为 false，无论你是否配置了required，配置了什么值，都是 false（可选配置）

用例：

@RequestParam(value = "userName", required = false) String userName,    

• @RequestBody
  用于将请求体的JSON串赋值给一个entity类型。

• @NotNull
  非空判断,禁止为空。主要用在基本数据类型上（int，Integer，Double）。不能为null，但可以为empty（“”," “,” "）,没有Size的约束。

• @Min
  被注解的元素的值必须大于等于最小值，
  并且类型为int，long，float，double。

用例：

@NotNull @Min(value = 1,message = "最小为1") @RequestParam("pageNum") int pageNum,

属性前

• @Autowired
  自动注入，略

方法前

• @ApiOperation
  Swagger包中的注解。使用该注解用来描述我们写的接口。

常用属性：
（1）value：接口名

• @ApiImplicitParams
  Swagger包中的注解。用于说明方法的一组请求参数。与@ApiImplicitParam搭配使用。

• @ApiImplicitParam
  Swagger包中的注解。用于说明方法的一组请求参数中的单个请求参数。

常用属性：
（1）name：参数名
（2）value：参数解释
（3）dataType：参数类型，有int，String等
（4）required：参数是否必须。有true和false
（5）paramType：参数放在什么地方。有header、query、path、body、form取值。

用例：

@ApiOperation(value = "分页查询XX列表")
@ApiImplicitParams({
	@ApiImplicitParam(name = "pageNum",value = "分页-第N页",dataType = "int", required = true),        
	@ApiImplicitParam(name = "pageSize",value = "分页-每页数量",dataType = "int", required = true),        				
	@ApiImplicitParam(name = "xxName",value = "xx名称",dataType = "String", required = false),        
})

类前

• @Api
  Swagger包中的注解。用在请求的类上面，表示对类的说明。

常用属性
（1）tags：说明该类的作用，能在UI界面看到。

用例：

@Api(tags = "xx管理界面")

二、Service类

类前

• @Service
  标注该类是Service类

方法前

• @DS
  指定数据源。在使用@DS注解实现多数据源连接时，需要先配置主数据源。主数据源是默认数据源，在没有使用@DS注解指定数据源时，默认使用主数据源。

三、Entity类

类前

• @Data
  在实体类前使用该注解，会自动生成get、set、toString、equals等方法。在idea中需要添加lombok插件，否则编译器会报红，但能正常运行。
• @TableName
  当数据库名与实体类名不一致或不符合驼峰命名时，需要在此注解指定表名（不加这个注解默认将实体类的小写形式在db中寻找）

value：指定数据库中该实体对应的表名

属性前

• @TableField
  解决实体类中字段与数据库中字段匹配相关问题。

value：该属性对应的表中字段名
exist：该字段在数据表中是否存在。true和false。

• @NotNull
• @NotBlank
  检查字符串是不是Null，被trim的长度是否大于0，只针对字符串且会去掉空格。
• @DecimalMin
  验证注解的元素值大于等于value值。但无法检验为Null的元素，因此常与@NotNull连用

value：

用例：

/**总金额 */
@DecimalMin(value = "0.00",message = "请检查money")
@NotNull(message = "money不能为空")
private BigDecimal money;