spring boot 常用注释

WEB 模块相关

• spring-boot-starter：核心模块，包括自动配置支持、日志和YAML
• spring-boot-starter-test：测试模块，包括JUnit、Hamcrest、Mockito
• spring-boot-starter-web

常用注解

• @RequestMapping =》处理地址映射的注解

• @PathVariable =》 用来获取请求路径（url)中的动态参数

  1. 示例

      /**
      * @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
      * 与 @PathVariable int id、@PathVariable String name、@PathVariable boolean status
      * 一一对应，按名匹配。
      */
  
      @RequestMapping(value = "user/login/{id}/{name}/{status}")
      @ResponseBody
      //@PathVariable注解下的数据类型均可用
      public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
      //返回一个User对象响应ajax的请求
          return new User(id, name, status);
      }
  

• @ResponseBody => 将客户端请求的数据解析为json 数据或者 xml 格式返回给HTTP响应正文（ResponseBody)中， 也就是客户端需要的数据。

• @Controller =》 spring mvc 中配置view 成的注解 ，可以通过此返回jsp 页面，重定向等 ，配合 @ResponseBody 就可以返回页面需要的数据 ，比如json 等。

• @RestController => @RestController注解相当于@ResponseBody ＋@Controller合在一起的作用。但是如果只是使用@RestController注解Controller，则Controller中的方法无法返回jsp页面。@RestController 注解更适合 restfulApi 项目的使用 。

• @RequestParam=> 页面传入参数名与方法参数名不一致时可以使用此注解绑定。

• @RequestBody=> 将ajax（datas）发出的请求写入 User 对象中。

• 组合注解（RequestMapping的升级版）

  1. @GetMapping = @RequestMapping(method = RequestMethod.GET)
  2. @PostMapping = @RequestMapping(method = RequestMethod.POST)
  3. @PutMapping = @RequestMapping(method = RequestMethod.PUT)
  4. @DeleteMapping = @RequestMapping(method = RequestMethod.DELETE)

  组合注解是方法级别的，只能用在方法上，我们的实例基本都用组合注解。

---

---

@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan
通常用在主类上。

@Repository:

用于标注数据访问组件，即DAO组件。

@Service:

用于标注业务层组件。

@Controller：

用于标注 controller 层。

@Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@RestController:

用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody。

@ResponseBody：

表示该方法的返回结果直接写入HTTP response body中
一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。

@PathVariable:

路径变量。参数与大括号里的名字一样要相同。

@RequestParam：

用在方法的参数前面，用来接收 get 请求 表单数据 ，约束是否是必须的 ， 默认值，起别名用来接收表单值 等如 ：

http://127.0.0.1:8080/user/login?username=admin&password=admin

public void test(@RequestParam(default="admintest",required=true) String username,@RequestParam(name="password") String pwd){
    
}

@ComponentScan：

当主启动类不在其他类的 父包中时，使用此注解扫描包含了所有类的包。

组件扫描。个人理解相当于，如果扫描到有@Component @Controller @Service等这些注解的类，则把这些类注册为bean。

@Configuration：

指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上。

@Bean:

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@EnableAutoConfiguration：

让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上。

@AutoWired:

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。
当加上（required=false）时，就算找不到bean也不报错。

@Qualifier：

当有多个同一类型的Bean时，可以用@Qualifier("name")来指定。与@Autowired配合使用

@Resource(name="name",type="type")：

没有括号内内容的话，默认byName。与@Autowired干类似的事。

@RequestMapping：

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
该注解有六个属性：
params:指定request中必须包含某些参数值是，才让该方法处理。
headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
value:指定请求的实际地址，指定的地址可以是URI Template 模式
method:指定请求的method类型， GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

@Profiles
Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。
任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。

@Configuration
@Profile("prod")
public class ProductionConfiguration {
    // ...
}

@ConfigurationProperties
Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。
你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@ControllerAdvice：
包含@Component。可以被扫描到。
统一处理异常。

@ExceptionHandler（Exception.class）：
用在方法上面表示遇到这个异常就执行以下方法。