Java 知识积累 - 注释相关

任初心

已于 2023-03-11 17:09:33 修改

阅读量149

点赞数

分类专栏： Java 知识积累文章标签： java spring spring boot

于 2023-03-11 17:07:22 首次发布

本文链接：https://blog.csdn.net/weixin_45671634/article/details/129327218

版权

Java 知识积累专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、前言

文章记录的注解是自身开发中用得相对较多的注解，后续不断补充完善。从事开发不久，也刚开始编写博客，内容输出以日常积累为主，各位前辈若看到文章，发现什么错误或有什么意见建议，还请不吝指教，万分感谢！

二、注解

@Controller

使用场景：用于控制层，表示类为控制器。不过在开发中，一般使用@RestController，该注解相当于 @RequestBody + @Controller
- 其中@ResponseBody 的作用是将接口的方法返回封装成 Body

@Service

使用场景：用于服务层，表示类为服务实现类。

@Repository

使用场景：用于持久层，即数据访问层，表示类为一个 DAO 类。

@RequestMapping

使用场景：用于 web 请求的路径映射，该注解包含多个参数如下，介绍几个可能会用上的：
- value 和 path：均用于指定路径，选用其一即可。
  - 例如：@RequestMapping(value = “/path”)
- method：指定 Http 的请求方式，包括：GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE。
  - 例如：@RequestMapping(method = RequestMethod.GET)
- params：映射请求的参数。
  - 例如：@RequestMapping( params={“userName=zhangsan”})，请求路径必须包含参数名 userName、参数值：zhangsan
- consumes：指定一个或多个前端给后端的媒体类型，其中一个必须与请求的 “Content-Type” 报头匹配。
  - 例如：@RequestMapping(consumes = {“text/plain”, “application/json”}
- produces：指定一个或多个后端给给前端的媒体类型，其中一个必须通过与请求的 “Accept” 包头匹配。
  - 例如：@RequestMapping(produces = {“application/json”}}

@PathVariable

使用场景：接收前端的请求路径参数
使用示例如下：

// 该接口请求后的结果示例： http://127.0.0.1/user/123
@GetMapping(value = "/user/{id}", produces = {"application/json"})
public AjaxResult getUserById(@PathVariable("id") Long id) {
    return AjaxResult.success(userService.getUserById(id));
}

@RequestPram

使用场景：接收前端的请求路径参数
使用示例如下：

// 该接口请求后的结果示例： http://127.0.0.1/user/id=123
@GetMapping(value = "/user", produces = {"application/json"})
public AjaxResult getUserById(@RequestParam("id") Long id) {
    return AjaxResult.success(userService.getUserById(id));
}

@PostMapping

使用场景：指定请求路径，一般用于新增数据，相当于 @RequestMapping(method = RequestMethod.POST)
该注解通常与 @RequestBody 配合接收请求参体
不支持幂等

@PutMapping

使用场景：指定请求路径，一般用于更新数据，相当于 @RequestMapping(method = RequestMethod.PUT)
支持幂等（幂等，即重复调用接口的结果和单次调用的结果一致）

@DeleteMapping

使用场景：指定请求路径，一般用于删除数据，相当于 @RequestMapping(method = RequestMethod.Delete)
支持幂等

@GetMapping

使用场景：指定请求路径，一般用于获取数据，相当于 @RequestMapping(method = RequestMethod.GET)
该注解通常与 @PathVarible 或 @RequestParam 配合接收请求参数
支持幂等
@Value
使用场景：用于从 yml 配置中读取属性
使用示例：

# yml 文件配置
server:
  port: 9020

# 在代码中读取
class ConfigurationReadExplain {
    @Value("${server.port}")
    private Long serverPort;
}

@ConfigurationProperties

使用场景：用于批量注入配置文件中的属性，功能类似@Value
使用示例：

# yml 文件配置
read:
    app-id: 123
    secret: abc

# 在代码中配置
@Data
@Component
@ConfigurationProperties(prefix = "read")
public class ConfigurationReadExplain {
    private Long appId;
    private String secret;
}

# 在代码中使用
public class ConfigurationUseSample {
    @Autowrie
    ConfigurationReadExplain  configurationReadExplain;
    
    public void getConfiguration() {
        Long appId = configurationReadExplain.getAppId();
        String secret = configurationReadExplain.getSecret();
    }
}