项目中常用注解整理

Mybatis/MybatisPlus

@TableName //用来将指定的数据库表和 JavaBean 进行映射
 
@TableId(type = IdType.AUTO) //标记为数据库中的主键
 
@TableField(exist=false) //标记为数据库中不存在的字段，防止报错
 
@Param
 
@param标签提供了对某个函数的参数的各项说明，包括参数名、参数数据类型、描述等。
 
@param标签要求您指定要描述参数的名称。您还可以包含参数的数据类型，使用大括号括起来，和参数的描述。

@TableField

字段填充策略 FieldFill

 LomBok

@Data
 
//1、@Data注解是lombok.jar包下的注解，该注解通常用在实体bean上，不需要写出set和get方法，但是具备实体bean所具备的方法，简化编程提高变成速度。
 
//2、@Data相当于@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这5个注解的合集。
 
@Builder
 
//@Builder注释为你的类生成相对略微复杂的构建器API
 
//@Builder可以放在类，构造函数或方法上
 
//@Builder内部帮我们做了什么？
 
//创建一个名为ThisClassBuilder的内部静态类，并具有和实体类形同的属性（称为构建器）。
 
//在构建器中：对于目标类中的所有的属性和未初始化的final字段，都会在构建器中创建对应属性。
 
//在构建器中：创建一个无参的default构造函数。
 
//在构建器中：对于实体类中的每个参数，都会对应创建类似于setter的方法，只不过方法名与该参数名相同。 并且返回值是构建器本身（便于链式调用），如上例所示。
 
//在构建器中：一个build()方法，调用此方法，就会根据设置的值进行创建实体对象。
 
//在构建器中：同时也会生成一个toString()方法。
 
//在实体类中：会创建一个builder()方法，它的目的是用来创建构建器。

JackSon

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern="yyyy-MM-dd HH:mm:ss")
 
//更改json中的日期格式

Spring

@PathVariable("xxx")
 
通过 @PathVariable 可以将URL中占位符参数{xxx}绑定到处理器类的方法形参中@PathVariable(“xxx“)
 
@RequestMapping(value=”user/{id}/{name}”)
 
请求路径：http://localhost:8080/hello/show5/1/james
 
@PostMapping注释将 HTTP POST 请求映射到特定的处理程序方法。 它是一个组合的注释，用作
 
@RequestMapping(method = RequestMethod.POST)的快捷方式。
 
@GetMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.GET)
 
@RestController
 
现在都是前后端分离，一般都不用@Controller注解，而是使用@RestController注解。
 
@RestController注解是@Controller和@ResponseBody的合集,
 
表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。
 
@Autowired
 
对类成员变量、方法及构造函数进行标注，让 spring 完成 bean 自动装配的工作

Swagger

@Api()    //使用在类上，tags : 说明该类的作用，参数是个数组，可以填多个
          //           description : 描述 
@ApiOperation    //使用在方法上, value : 标明方法用处
                 //             notes : 备注
@ApiImplicitParams    //用在请求的方法上，包含多@ApiImplicitParam
@ApiImplicitParam     //用于方法，表示单独的请求参数
//name="参数ming" 
//value="参数说明" 
//dataType="数据类型" 
//paramType="query" 表示参数放在哪里
//    header 请求参数的获取：@RequestHeader
//    query   请求参数的获取：@RequestParam
//    path（用于restful接口） 请求参数的获取：@PathVariable
//    body（不常用）
//    form（不常用） 
//defaultValue="参数的默认值"
//required="true" 表示参数是否必须传