项目中的注解及其作用

心已赠人 2023-10-06 22:41 5阅读 0赞

1、@RestController

> @RestController 是@controller和@ResponseBody 的结合
> 
> ![3e043dab877741ce9d7b0eba144b2eb5.png][]

2、@ResponseBody

> @ResponseBody 它的作用简短的说就是指该类中所有的[API][]接口返回的数据，甭管你对应的方法返回Map或是其他Object，它会以Json字符串的形式返回给客户端
> 
> ![58dc44b36b744a36b0863789adf21a68.png][]

3、@Controller

> @Controller 将当前修饰的类注入SpringBoot [IOC][]容器，使得从该类所在的项目跑起来的过程中，这个类就被实例化。

4、 @NoRepeatSubmit

> 这个是redis中自己定义的一个 防止重复提交标记的注解
> 
> ![abc1c1fc0b08435fabcd6b9de9bd7e1f.png][]
> 
> ![ba443736a0df4b28b130ff252093cf6d.png][]

5、@ApiImplicitParams

> swagger中的**@ApiImplicitParams**作用在方法上，用于设置单个请求参数
> 
> **@ApiImplicitParams** 作用在方法上，用于包含多个 @ApiImplicitParam
> 
> 各个参数说明
> 
>  *  name：参数名
>  *  value：参数解释
>  *  required：参数是否必须
>  *  dataType：参数类型
>  *  paramType：参数放在哪个地方，有以下取值
>     
>      *  header：请求头
>      *  query：?param=value的形式
>      *  path：路径，Restful风格接口
>      *  body：请求体
>      *  form：以form表单的形式提交
> 
> ![1ae25aaf177e4ca189f6c972a9152da3.png][]

6、@ApiVersion

> @ApiVersion自定义的一个注解，是版本号
> 
> ![1c9850dd66e54cf49d77494ed1c154f1.png][]
> 
> ![c4d3d32284214e1fbe050d3ec8e82fb6.png][]

@Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ApiVersion {
        /**
         * @return 版本号
         */
        int value() default 1;
    }

7、@RequestMapping

> Spring MVC 中使用 @RequestMapping 来映射请求，也就是通过它来指定控制器可以处理哪些URL请求，相当于Servlet中在web.xml中配置的映射作用一致。
> 
>  *  @RequestMapping 注解在 Controller 类上，这时类的注解是相对于 Web 根目录，而方法上的是相对于类上的路径
>  *  @RequestMapping 中可以使用 params 来限制请求参数
>  *  @RequestMapping 中的 method 主要用来定义接收浏览器发来的何种请求

8、@Log

> 自定义操作日志记录注解
> 
>     @Target({ ElementType.PARAMETER, ElementType.METHOD })
>     @Retention(RetentionPolicy.RUNTIME)
>     @Documented
>     public @interface Log
>     {
>         public String value() default "";
>         /**
>          * 功能
>          */
>         public BusinessType businessType() default BusinessType.OTHER;
>     }

9、 @PreAuthorize

>     @PreAuthorize("hasAuthority('/examinee')")
> 
> @PreAuthorize 注解，顾名思义是进入方法前的权限验证，@PreAuthorize 声明这个方法所需要的权限表达式

10、@Autowired

> **@Autowired**
> 
> 默认通过类型注入，如存在多个类型则通过名称注入 小写首字母作为名称
> 
> **@Resource**
> 
> 默认通过名称注入，如名称无法找到，则通过类型注入
> 
> ![66fcb108726c420cb542beef79851981.png][]

11、@TableId

> **@TableId**
> 
> 主键注解的意思
> 
> @TableId(type=IdType.AUTO) 根据当前表中id最大值自增+1
> 
> **@TableName**
> 
> 数据库表名注解
> 
> ![cf0dd39888a64ed5b53b48f8572207f3.png][]

12、@JsonFormat

> @JsonFormat
> 
> 储存在mysql的时间是date类型的，当我们读出来封装在实体类中的时候，读出来的是英文时间格式，我们需要用JsonFormat注解来格式化我们的时间
> 
> 注：要注意的是，它只会在声明返回类型为json时，比如使用@ResponseBody返回json数据的时候，才会返回格式化的yyyy-MM-dd HH:mm:ss时间，如果直接使用System.out.println()输出的话，仍然是类似“Fri Dec 01 21:05:20 CST 2017”这样的时间样式。  
>   
> ![aefae513836f473eae7ebc80253d999c.png][]

13、@TableField(exist=false)

> @TableField(exist=false)
> 
> 注解加在bean属性上，表示当前属性不是数据库的字段，但在项目中必须使用。
> 
> ![395b99d6611e44969c27dd7ee4c3bcd7.png][]

14、**@TableField(fill = FieldFill.INSERT\_UPDATE)**

> 插入和更新填充字段
> 
> ![8b7453a8357b4cf2a48f493e8113d9e4.png][]

15、 **@Param**

> **@Param**
> 
> mapper中在参数前加
> 
>     @Param("roomId") Long roomId
> 
> 意味着映射到xml中的 \#\{roomId\}
> 
> ![9f9287efc08f408ba3c873cda8991c65.png][]

16、 **@PathVariable**

> **@PathVariable**
> 
> URL占位符注解，将url中占位符参数绑定到入参
> 
> ![d183c543c56a4271bf889bc4b3c972bb.png][]
> 
> @RequestParam
> 
> 前端访问的时候是
> 
> key=value形式，如?id=1&name=zhaohong
> 
> 可以通过配置设置是否必须填写，默认不是必须的

17、 **@Excel**

> 自定义的Excel注解，方便导出的时候，展示出来
> 
> ![e4ef4d986bc44732adc722b60c00b556.png][]

[3e043dab877741ce9d7b0eba144b2eb5.png]: https://img-blog.csdnimg.cn/3e043dab877741ce9d7b0eba144b2eb5.png
[API]: https://so.csdn.net/so/search?q=API&spm=1001.2101.3001.7020
[58dc44b36b744a36b0863789adf21a68.png]: https://img-blog.csdnimg.cn/58dc44b36b744a36b0863789adf21a68.png
[IOC]: https://so.csdn.net/so/search?q=IOC&spm=1001.2101.3001.7020
[abc1c1fc0b08435fabcd6b9de9bd7e1f.png]: https://img-blog.csdnimg.cn/abc1c1fc0b08435fabcd6b9de9bd7e1f.png
[ba443736a0df4b28b130ff252093cf6d.png]: https://img-blog.csdnimg.cn/ba443736a0df4b28b130ff252093cf6d.png
[1ae25aaf177e4ca189f6c972a9152da3.png]: https://img-blog.csdnimg.cn/1ae25aaf177e4ca189f6c972a9152da3.png
[1c9850dd66e54cf49d77494ed1c154f1.png]: https://img-blog.csdnimg.cn/1c9850dd66e54cf49d77494ed1c154f1.png
[c4d3d32284214e1fbe050d3ec8e82fb6.png]: https://img-blog.csdnimg.cn/c4d3d32284214e1fbe050d3ec8e82fb6.png
[66fcb108726c420cb542beef79851981.png]: https://img-blog.csdnimg.cn/66fcb108726c420cb542beef79851981.png
[cf0dd39888a64ed5b53b48f8572207f3.png]: https://img-blog.csdnimg.cn/cf0dd39888a64ed5b53b48f8572207f3.png
[aefae513836f473eae7ebc80253d999c.png]: https://img-blog.csdnimg.cn/aefae513836f473eae7ebc80253d999c.png
[395b99d6611e44969c27dd7ee4c3bcd7.png]: https://img-blog.csdnimg.cn/395b99d6611e44969c27dd7ee4c3bcd7.png
[8b7453a8357b4cf2a48f493e8113d9e4.png]: https://img-blog.csdnimg.cn/8b7453a8357b4cf2a48f493e8113d9e4.png
[9f9287efc08f408ba3c873cda8991c65.png]: https://img-blog.csdnimg.cn/9f9287efc08f408ba3c873cda8991c65.png
[d183c543c56a4271bf889bc4b3c972bb.png]: https://img-blog.csdnimg.cn/d183c543c56a4271bf889bc4b3c972bb.png
[e4ef4d986bc44732adc722b60c00b556.png]: https://img-blog.csdnimg.cn/e4ef4d986bc44732adc722b60c00b556.png