08_springboot常用注解解读

1 Spring Bean 相关

1.1 @Autowired 以及相关的@Component、@Repository、@Service、@RestController/Controller

@Autowired 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Autowired 注解自动装配的 bean 的类,可以采用以下注解实现：

@Component ：通用的注解，可标注任意类为 Spring 组件。如果一个 Bean 不知道属于哪个层，可以使用@Component 注解标注；
@Repository : 对应持久层即 Dao 层，主要用于数据库相关操作；
@Service : 对应业务层；
@RestController/Controller : 对应 Spring MVC 控制层；

1.2 @RestController

@RestController注解是@Controller和@ResponseBody的合集，将函数的返回值直接直接返回。这是前后端分离的产物。

1.3 @Scope

四种常见的 Spring Bean 的作用域：

singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的。
prototype : 每次请求都会创建一个新的 bean 实例。
request : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有效。
session : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。

1.4 @Configuration

Configuration注解声明配置类。

2 处理常见的 HTTP 请求类型

5 种常见的请求类型:

GET ：请求从服务器获取特定资源。
POST ：在服务器上创建一个新的资源。
PUT ：更新服务器上的资源（客户端提供更新后的整个资源）。
DELETE ：从服务器删除特定的资源。

2.1 GET 请求

@GetMapping("/get-users") 等价于@RequestMapping(value="/get-users",method=RequestMethod.GET)
@GetMapping("/get-users")
public List<User> getAllUsers() {
 	return UserService.findAll();
}

2.2 POST 请求

3.2. POST 请求
@PostMapping("/get-users") 等价于@RequestMapping(value="/get-users",method=RequestMethod.POST)
关于@RequestBody注解的使用，在下面的“前后端传值”这块会讲到。
@PostMapping("/get-users")
public User createUser(@Valid @RequestBody User user) {
 return userService.save(user);
}

2.3 PUT 请求

@PutMapping("/users/{userId}") 等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)
@PutMapping("/users/{userId}")
public User updateUser(@PathVariable(value = "userId") Long userId,
  @Valid @RequestBody User user) {
  ......
}

2.4 DELETE 请求

@DeleteMapping("/users/{userId}")等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)
@DeleteMapping("/users/{userId}")
public User deleteUser(@PathVariable(value = "userId") Long userId){
  ......
}

3 前后端传值

3.1 @PathVariable 和 @RequestParam

@PathVariable用于获取路径参数
@RequestParam用于获取查询参数

@RestController
public class ParameterController {
    @GetMapping("/get-users/{userid}")
    public String getUsers(@PathVariable("userid") Integer userid,
                           @RequestParam("username") String username) {
        return "ok" + userid + username;
    }
}

3.2 @RequestBody

用于读取 Request 请求（可能是 POST,PUT,DELETE,GET 请求）的 body 部分并且Content-Type 为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用HttpMessageConverter或者自定义的HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。

package com.zs.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.ToString;
import java.io.Serializable;

@Data
@ToString
@ApiModel("用户实体")
public class User implements Serializable {
    private static final long serialVersionUID = -6056125703075132981L;
    @ApiModelProperty("用户Id")
    private Integer id;
    @ApiModelProperty("用户账号")
    private String account;
    @ApiModelProperty("用户密码")
    private String password;
    @ApiModelProperty("用户名称")
    private String username;
}

package com.zs.controller;

import com.zs.pojo.User;
import org.springframework.web.bind.annotation.*;

@RestController
public class ParameterController {

    @PostMapping("/get-users")
    public User getUsers(@RequestBody User user) {
        return user;
    }
}

需要注意的是：一个请求方法只可以有一个@RequestBody，但是可以有多个@RequestParam和@PathVariable。

4 读取配置信息

4.1 @value(常用)

使用 @Value("${property}") 读取比较简单的配置信息：

@SpringBootTest
public class SpringbootTest {
    @Value("${spring.datasource.type}")
    String datasourceType;
    @Test
    void contextLoads() {
        System.out.println(datasourceType);
    }
}

输出：com.alibaba.druid.pool.DruidDataSource