常用的注解

白秋
681 阅读6分钟

1、lombok中的注解

  • @Data ： 注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法；
  • @AllArgsConstructor ： 注在类上，提供类的全参构造；
  • @NoArgsConstructor ： 注在类上，提供类的无参构造；
  • @Setter ： 注在属性上，提供 set 方法；
  • @Getter ： 注在属性上，提供 get 方法；
  • @EqualsAndHashCode ： 注在类上，提供对应的 equals 和 hashCode 方法；
  • @Log4j/@Slf4j ： 注在类上，提供对应的 Logger 对象，变量名为 log；
  • @Accessors：该注解用来配置lombok如何产生和显示getters和setters的方法。该注解有三个属性：
    • fluent：一个布尔值，如果为true生成的get/set方法则没有set/get前缀，默认为false；
    • chain：一个布尔值，如果为true生成的set方法返回this，为false生成的set方法是void类型。默认为false，除非当fluent为true时，chain默认则为true；
    • prefix：为一系列string类型，可以指定前缀，生成get/set方法时会去掉指定的前缀。

2、mybatis-plus中的注解

  • @TableName：表名注解；
  • @TableField：在插入和更新数据时，字段自动插入/更新为当前时间；
    /**
* 新增/更新时间 自动填充
*/
@TableField(value = "UPDATE_DATE", fill = FieldFill.INSERT_UPDATE)
private Date updateDate;

3、spirng中的注解

  • @RequestBody：@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

  • @Order：在Spring 4.2中利用@Order控制配置类的加载顺序；Spring在加载Bean的时候，有用到order注解；通过@Order指定执行顺序，值越小，越先执行；@Order注解常用于定义的AOP先于事物执行；order如果不标注数字，默认最低优先级，因为其默认值是int最大值。

  • Spirng缓存注解:

    • Cacheable：主要针对方法配置，能够根据方法的请求参数对其结果进行缓存。
    • @CachePut：主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和@Cacheable不同的是，它每次都会触发真实方法的调用。
    • @CacheEvict：主要针对方法配置，能够根据一定的条件对缓存进行清空。
    • @CacheConfig：抽取缓存公共配置，可以标注在类上。

4、swagger中的注解

  • @ApiOperation与ApiParam共同为API的生成做注解。它们的属性如下：
    • @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”）。
    • @ApiParam(required = “是否必须参数”, name = “参数名称”, value = “参数具体描述”）。
  • @ApiIgnore：注解主要作用在方法上，类上，参数上。当作用在方法上时，方法将被swagger忽略；作用在类上时，整个类都会被swagger忽略；作用在参数上时，单个具体的参数会被忽略。

5、其他的注解

  • @JsonFormat：JsonFormat注解是jackson包里面的一个注解，在时间格式化时使用，比如我们存储在mysql中的数据是date类型的，当我们读取出来封装在实体类中的时候，就会变成英文时间格式，而不是yyyy-MM-ddHH:mm:ss这样的中文时间，因此我们需要用到JsonFormat注解来格式化时间。
  • @Scheduled：该注解配置到方法上来完成对应的定时任务的配置，如执行时间，间隔时间，延迟时间等等。该注解的参数如下：

    • corn：该属性接收的cron表达式支持占位符。cron表达式语法

      [秒] [分] [小时] [日] [月] [周] [年]

      [年]不是必须的域，可以省略[年]，则一共6个域

      通配符说明:

      • * 表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。
      • ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
      • - 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
      • , 表示指定多个值，例如在周字段上设置 “MON,WED,FRI”表示周一，周三和周五触发
      • / 用于递增触发。如在秒上面设置”5/15”表示从5秒开始，每增15秒触发(5,20,35,50)。 在日字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
      • L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于”7”或”SAT”。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
      • W 表示离指定日期的最近那个工作日(周一至周五).例如在日字段上置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)。
      • # 序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；
      • 小提示： ’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发；周字段的设置，若使用英文字母是不区分大小写的，即MON与mon相同。
        示例
每隔5秒执行一次：*/5 * * * * ?
每隔1分钟执行一次：0 */1 * * * ?
每天23点执行一次：0 0 23 * * ?
每天凌晨1点执行一次：0 0 1 * * ?
每月1号凌晨1点执行一次：0 0 1 1 * ?
每月最后一天23点执行一次：0 0 23 L * ?
每周星期六凌晨1点实行一次：0 0 1 ? * L
在26分、29分、33分执行一次：0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?

    • zone：时区，接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

    • fixedDelay：上一次执行完毕时间点之后多长时间再执行。

    • fixedDelayString：与fixedDelay意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

    • fixedRate：

    • fixedRateString：

    • initialDelay：

    • initialDelayString：

avatar
文章
阅读
粉丝