Spring Boot常用注解

目录

@SpringBootApplication

@RestController

@RequestMapping

@GetMapping、@PostMapping、@PutMapping、@DeleteMapping

@Autowired

@Component、@Service、@Repository、@Controller

@Value

---

@SpringBootApplication

• 功能概述：这是 Spring Boot 应用的核心注解，它是一个组合注解，包含了@Configuration、@EnableAutoConfiguration和@ComponentScan。用于开启自动配置，扫描组件等功能，标记一个类作为 Spring Boot 应用的主配置类。
• 

• import org.springframework.boot.SpringBootApplication;
  import org.springframework.boot.autoconfigure.SpringBootAutoConfiguration;
  import org.springframework.context.annotation.ComponentScan;
  import org.springframework.context.annotation.Configuration;
  
  @SpringBootApplication
  public class MySpringBootApp {
      public static void main(String[] args) {
          Spring.application.run(MySpringBootApp.class, args);
      }
  }

• 细节解释：
  • 当使用@SpringBootApplication注解一个类时，@Configuration注解使得这个类可以作为一个 Java 配置类，能够在其中定义 Bean 等配置信息。
  • @EnableAutoConfiguration会根据项目中添加的依赖自动配置 Spring 应用上下文。例如，当项目的 classpath 下有spring - webmvc依赖时，它会自动配置 Spring MVC 相关的组件。
  • @ComponentScan用于指定 Spring 要扫描的包路径，以发现@Component、@Service、@Repository和@Controller等注解标记的组件。默认情况下，它会扫描@SpringBootApplication注解所在类的同包及子包下的所有组件。

• @RestController

• 功能概述：用于创建 RESTful 风格的 Web 服务。它是@Controller和@ResponseBody的组合注解。@Controller表示这个类是一个 Spring MVC 的控制器，用于处理 HTTP 请求；@ResponseBody表示方法的返回值直接写入 HTTP 响应体中，而不是返回一个视图名称。
• 示例

• import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  @RestController
  public class MyController {
      @GetMapping("/hello")
      public String sayHello() {
          return "Hello, World!";
      }
  }

• 细节解释：
  • 在上述示例中，@RestController注解表明MyController类是一个 RESTful 风格的控制器。当客户端发送一个GET请求到/hello路径时，sayHello方法会被调用，并且返回的字符串"Hello, World!"会直接作为 HTTP 响应体返回给客户端。

• @RequestMapping

• 功能概述：用于将 HTTP 请求映射到 MVC 和 RESTful 控制器的处理方法上。可以应用在类级别和方法级别。在类级别上使用时，它定义了一个基本的请求路径，方法级别上的RequestMapping注解会在这个基本路径上进行进一步的细化。
• 示例：

  import org.springframework.web.bind.annotation.RequestMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  @RestController
  @RequestMapping("/api")
  public class MyApiController {
      @RequestMapping("/users")
      public String getUsers() {
          return "List of users";
      }
  }

• 细节解释：
  • 在这个例子中，类级别上的@RequestMapping("/api")定义了所有该类中方法的基本路径是/api。而getUsers方法上的@RequestMapping("/users")则表示该方法处理/api/users路径的请求。这个注解支持多种 HTTP 方法，如GET、POST、PUT、DELETE等，可以通过method属性来指定具体的方法，例如@RequestMapping(value = "/users", method = RequestMethod.GET)。

• @GetMapping、@PostMapping、@PutMapping、@DeleteMapping

• 功能概述：这些注解是@RequestMapping的简化版本，用于分别处理GET、POST、PUT和DELETE请求。它们使得代码更加简洁和易读。
• 示例：

• import org.springframework.web.bind.annotation.DeleteMapping;
  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.PostMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  @RestController
  public class MyCrudController {
      @GetMapping("/items")
      public String getItems() {
          return "List of items";
      }
  
      @PostMapping("/items")
      public String createItem() {
          return "Item created";
      }
  
      @PutMapping("/items")
      public String updateItem() {
          return "Item updated";
      }
  
      @DeleteMapping("/items")
      public String deleteItem() {
          return "Item deleted";
      }
  }

• 细节解释：
  • 以@GetMapping为例，它等价于@RequestMapping(method = RequestMethod.GET)。这些注解使得代码更符合 RESTful 风格的 API 设计，让开发者能够一眼看出每个方法处理的 HTTP 请求类型和路径。

• @Autowired

• 功能概述：用于自动装配 Spring 容器中的 Bean。它可以应用在字段、构造函数、方法上。Spring 会根据类型自动查找并注入匹配的 Bean 实例。

• import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.stereotype.Service;
  
  @Service
  public class MyService {
      @Autowired
      private MyRepository myRepository;
      //...
  }

• 细节解释：
  • 在这个例子中，MyService类中的myRepository字段被标注为@Autowired。Spring 会在容器中查找类型为MyRepository的 Bean，并将其注入到myRepository字段中。如果有多个相同类型的 Bean，还可以通过@Qualifier注解来指定具体要注入的 Bean 的名称。

• @Component、@Service、@Repository、@Controller

• 功能概述：
  • @Component：是一个通用的 Spring 组件注解，用于标记一个类为 Spring 容器中的组件。
  • @Service：用于标记业务逻辑层的组件，主要用于处理业务逻辑，让代码结构更加清晰，语义更明确。
  • @Repository：用于标记数据访问层（如数据库访问）的组件，它还能自动处理数据库操作相关的异常，将其转换为 Spring 的DataAccessException体系中的异常。
  • @Controller：用于标记 Spring MVC 中的控制器组件，负责处理 HTTP 请求并返回响应。
• 示例：

• import org.springframework.stereotype.Component;
  import org.springframework.stereotype.Controller;
  import org.springframework.stereotype.Repository;
  import org.springframework.stereotype.Service;
  
  @Component
  public class MyComponent {
      //...
  }
  
  @Service
  public class MyBusinessService {
      //...
  }
  
  @Repository
  public class MyDataRepository {
      //...
  }
  
  @Controller
  public class MyWebController {
      //...
  }

• 细节解释：
  • 这些注解都是@Component的特殊化注解，它们的主要作用是为了更好地分层和组织代码。例如，使用@Repository注解的数据访问层组件，Spring 会对其进行特殊处理，如提供数据库事务管理等功能。并且在组件扫描时，Spring 能够自动发现并注册这些注解标记的类为 Bean，方便在其他组件中进行自动装配。

• @Value

• 功能概述：用于注入外部配置文件（如application.properties或application.yml）中的属性值。
• 示例：

• import org.springframework.beans.factory.annotation.Value;
  import org.springframework.stereotype.Component;
  
  @Component
  public class MyConfiguredComponent {
      @Value("${myapp.name}")
      private String appName;
      //...
  }

• 细节解释：
  • 在这个例子中，@Value("${myapp.name}")会从配置文件中读取myapp.name属性的值，并将其注入到appName字段中。配置文件可以是application.properties格式（例如myapp.name = My Awesome App），也可以是application.yml格式（例如myapp: name: My Awesome App）。这使得应用的配置更加灵活，可以在不修改代码的情况下通过修改配置文件来改变应用的行为。

一个完成控制器的代码

package net.lzzy.practices.web.admin;

import net.lzzy.practices.constants.ApiConstant;

import net.lzzy.practices.constants.Messages;
import net.lzzy.practices.entities.User;
import net.lzzy.practices.services.UserService;
import net.lzzy.practices.web.models.ApiResult;
import net.lzzy.practices.web.models.VmUser;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;
import java.util.UUID;

/**
 * @author Dengxin
 */
@CrossOrigin
@RestController
@RequestMapping(ApiConstant.ROUTE_USER_ROOT)
public class UserApiController {
    private  final UserService service;

    public UserApiController(UserService service) {
        this.service = service;
    }

    //从数据库获取所以用户，用get方法
    @GetMapping(ApiConstant.ROUTE_USER_ALL)
    public ApiResult getUsers(@RequestParam String token){
        List<VmUser> users=new ArrayList<>();
        service.get().forEach(u ->users.add(VmUser.create(u,true)));
        return new ApiResult(true,users.size()+"",users);
    }
    @GetMapping(ApiConstant.ROUTE_USER_PAGE)
    public ApiResult getPageUser(@RequestParam int page, @RequestParam int size,@RequestParam String token){
        List<VmUser> users=new ArrayList<>();
        service.get(page, size).forEach(u ->users.add(VmUser.create(u,true)));
        return  new ApiResult(true,users.size()+"",users);
    }
    @GetMapping(ApiConstant.ROUTE_USER_SEARCH)
    public ApiResult search(@RequestParam String token, @PathVariable String kw){
        List<VmUser> users=new ArrayList<>();
        service.search(kw).forEach(u-> users.add(VmUser.create(u,true)));
        return new ApiResult(true, users.size()+"",users);
    }

    @GetMapping(ApiConstant.ROUTE_USER_APPLYING)
    public ApiResult getApplyingTeacher(@RequestParam String token){
        List<VmUser> users=new ArrayList<>();
        service.getByApplyTeacher(true).forEach(u ->users.add(VmUser.create(u,true)));
        return  new ApiResult(true,users.size()+"",users);
    }

    @PostMapping(ApiConstant.ROUTE_USER_APPROVE)
    public ApiResult approve(@RequestParam String token,@RequestParam UUID id){
        User user = service.applyTeacher(id);
        if(user==null){
            return new ApiResult(false, Messages.WRONG_ID.toString(), null);
        }
        return new ApiResult(true,Messages.SUCCESS.toString(), VmUser.create(user,true));
    }

    @PostMapping(ApiConstant.ROUTE_USER_DECLINE)
    public ApiResult decline(@RequestParam String token,@RequestParam UUID id){
        User user = service.applyTeacher(id);
        if(user==null){
            return new ApiResult(false, Messages.WRONG_ID.toString(), null);
        }
        return new ApiResult(true,Messages.SUCCESS.toString(), VmUser.create(user,true));
    }

    @PostMapping(ApiConstant.ROUTE_USER_BAN)
    public ApiResult ban(@RequestParam String token,@RequestParam UUID id){
        User user = service.applyTeacher(id);
        if(user==null){
            return new ApiResult(false, Messages.WRONG_ID.toString(), null);
        }
        return new ApiResult(true,Messages.SUCCESS.toString(), VmUser.create(user,true));
    }

}