SpringBoot相关注解

SpringBoot相关注解

• @SpringBootApplication

  • SpringBoot的核心注解，目的是开启自动配置，例如扫描Controller等四个版型标签，WebMvc项目配置DispatcherServlet
  • 一般SpringBoot项目中只有一个启动配置类，也就是贴了@SpringBootApplication注解的类
  • 该注解上又贴了下面三个注解
    • @SpringBootConfiguration：该注解上又贴了@Configuration注解，也就是说主类也间接贴了@Configuration注解，最终表示主类是个配置类，里面能配置@Bean对象
    • @ComponentScan：表示会扫描主配置类所在包路径下的所有包及其子包里的版型标签，即解决了配置版型标签注解解析器这一步骤
    • @EnableAutoConfiguration注解：该注解上贴了@Import(AutoConfigurationImportSelector.class)注解，表示导入了自动配置选择器这个类，这个类有个方法，getCandidateConfigurations()，该方法主要是去读取jar包中的META-INF/spring.factories文件，并加载该文件里配置的自动配置对象，比如FreeMarker、DataSource、DispatcherServlet、WebMvc等等；加载后，需要让这些对象起作用，那么得满足相应的条件才行；比如，需要用到WebMvc，则需要满足@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })这些条件，当满足这些条件后，WebMvc对象就起作用了，SpringBoot就会帮我们构建出使用SpringMVC需要的先行条件，比如在Tomcat中配置DispatcherServlet

• @ComponentScan：Spring配置扫描注解，扫描basePackages属性指定包路径下的所有包及其子包内的贴有版型标签的类

  • 版型标签: Controller、Service、Repository、Component
  • 如果没有指定包路径，则默认扫描该配置类所在的包路径
  • 等价于

• @Configuration

  • Spring配置类注解，贴了这个注解，表示这个类是配置类，等价于applicationContext.xml文件

• @Bean：Spring实例注解，贴有该注解的方法是实例方法

  • 实例方法返回的对象会交给Spring容器管理起来
  • bean标签中name属性等价于@Bean注解中name/value属性
  • bean标签中id属性等价于实例方法的方法名
  • bean标签中init-method属性等价于@Bean注解中initMethod属性
  • bean标签中destroy-method属性等价于@Bean注解中destroyMethod属性
  • bean标签中scope属性等价于实例方法中的@Scope注解
  • 例如，@Bean(value = "someBean", initMethod = "init", destroyMethod = "destroy")
  • 功能等价于

• @ImportResource：Spring配置文件导入注解，导入applicationContext.xml类型的配置文件，贴在配置类上

  • 如果一个配置类要使用到xml配置中的Bean，可以使用该注解
  • 传入另一个xml配置文件的class路径即可，例如，@ImportResource("classpath:applicationContext.xml")

• @Import：Spring配置类导入注解，导入另一个配置类，贴在配置类上

  • 如果一个配置类要使用另一个配置类中的Bean，可以使用该注解
  • 传入另一个配置类的字节码对象即可，例如，@Import(OtherConfig.class)

• @Autowired：Spring属性注入注解

  • 从Spring容器中拿到Bean，并注入到属性或字段中，贴在属性或set方法上
  • 先根据属性类型去查找，再根据属性名称作为id去找
  • 可以使用@Qualifier注解来按照id名称查找，配合@Autowired注解使用

• @Resource：Spring属性注入注解

  • 从Spring容器中拿到Bean，并注入到属性或字段中，贴在属性或set方法上
  • 先根据属性名称作为id去查找，再根据属性类型去找
  • 可以指定name属性查找，若指定，则只能按照name属性值查找@Resource(name="")

• @ModelAttribute：SpringMvc注解，贴在参数列表上

  • 获取到前台传过来的参数，封装到对象中，然后将对象封装到Model中
  • 可以通过value属性给对象取别名，如果不取别名，model中key是对象的类名，首字母大写转小写
  • 等价于model.addAttribute("别名", 对象)

• @RequestMapping：SpringMvc注解，贴在类或方法上，用来处理请求地址映射

  • 可以限定请求类型和响应类型等
  • 可用于类或方法上
    • 用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径
    • 用于方法上，表示请求资源访问路径需要匹配到该映射路径，该方法才能被执行

      @Controller
      @RequestMapping("/v1")
      public class HelloController {
      
          @RequestMapping(value = "/hello")
          public ModelAndView hello() {
              ModelAndView modelAndView = new ModelAndView();
      
              //在Model中装入数据
              modelAndView.addObject("msg", "你好，欢迎使用Spring MVC前端控制器");
              //设置视图，跳转到指定jsp
              modelAndView.setViewName("/jsp/hello.jsp");;
      
              return modelAndView;
          }
      
      }
      

  • params:指定request中必须包含某些参数值时，才让该方法处理
  • headers:指定request中必须包含某些指定的header值，才能让该方法处理请求
  • value:指定请求的实际地址，指定的地址可以是URI Template模式，可以指定多个
  • method:指定请求的method类型， GET、POST、PUT、DELETE等
  • consumes:指定处理请求的提交内容类型（Content-Type），如application/json;text/html

• @ResponseBody：SpringMvc注解，贴在方法上

  • 方法上贴了该注解后，不会再跳转到其它页面，而是会返回给前台一个Json数据

    @RequestMapping("/login")
    @ResponseBody
    public User login(User user){
        return user;
    }
    

    {"username":"kingyumu","password":"123456"}
    

• @PathVariable：SpringMvc注解，贴在参数列表中

  • 映射URL绑定的占位符

    //URL中的 {xxx} 占位符可以通过 @PathVariable("xxx") 绑定到操作方法的入参中
    @RequestMapping("/user/{id}")
    public String testPathVariable(@PathVariable("id") String id){
        System.out.println("路径上的占位符的值="+id);
        return "success";
    }
    

  • 如果请求为localhost:8080/user/admin，可以输出路径上的占位符的值=admin

• @RequestParam：SpringMvc注解，贴在参数列表上

  • 可以对传入参数指定参数名

    @RequestParam String inputStr  
    // 下面的对传入参数指定为aa，如果前端不传aa参数名，会报错  
    @RequestParam(value="aa") String inputStr 
    

  • 可以通过required=false或者true来要求@RequestParam配置的前端参数是否一定要传

    // required=false表示不传的话，会给参数赋值为null，required=true就是必须要有  
    @RequestMapping("testRequestParam")    
    public String filesUpload (
            @RequestParam(value="aa", required=true) String inputStr,HttpServletRequest request
        )
    

  • 如果用@RequestParam注解的参数是int基本类型，但是required=false，这时如果不传参数值会报错，因为不传值，会赋值为null给int，这个不可以

    @RequestMapping("testRequestParam")    
    public String filesUpload(
            @RequestParam(value="aa", required=true) String inputStr, 
            @RequestParam(value="inputInt", required=false) int inputInt,
            HttpServletRequest request) {    
        // ......省略  
        return "index";  
    }
    

• @ControllerAdvice：贴在类上

  • 控制器功能增强注解，在请求进入映射方法之前进行功能增强

    @ControllerAdvice
    public class ErrorAdvice {
        /**
        * @ExceptionHandler 异常处理器，处理捕获到的异常，执行此方法，此方法的定义规则与映射方法一致
        * @return 返回一个指定页面
        */
        @ExceptionHandler(RuntimeException.class)
        public String error() {
            return "/error/errorPage.html";
        }
    }
    

  • 如果需要传值到界面时需要使用ModelAndView对象返回

• @ExceptionHandler：贴在方法上，配合@ControllerAdvice一起使用

  /**
   * 告诉SpringMVC这个方法专门处理这个类发生的异常
   *      1、给方法上随便写一个Exception，用来接受发生的异常
   *      2、要携带异常信息不能给参数位置写Model
   *      3、返回ModelAndView就行了
   *      4、如果有多个@ExceptionHandler都能处理这个异常，精确优先
   *      5、全局异常处理与本类同时存在，本类优先
   */
  @ExceptionHandler(value = { Exception.class })
  public ModelAndView handleException01(Exception exception) {
      System.out.println("本类的：handleException01..." + exception);
      //
      ModelAndView view = new ModelAndView("myerror");
      view.addObject("ex", exception);
      // 视图解析器拼串
      return view;
  }
  

• @RestController：SpringMvc注解，贴在类上或方法上
  @RestController = @Controller + @ResponseBody

  • 贴在类上时，方法上不能再贴@ResponseBody注解

• 四个版型标签

  • 这四个注解功能都相同，只是表示的意义不同而已
  • @Controller：贴在表示层
  • @Service：贴在业务类上
  • @Repository：贴在数据访问层
  • @Component：当被贴的类不属于任何一层时，用该注解

• @Transactional：Spring Aop注解，用来配置事务，可以贴在类或方法上

  • 常用属性readOnly：该属性用于设置当前事务是否为只读事务，设置为 true 表示只读，false 则表示可读写，默认值为 false，该属性一般用于只查询的方法上

• @MapperScan，贴在主配置类上，配合@Configuration使用

  • 扫描basePackages属性中指定包路径下的mapper接口，并为mapper接口动态创建实现类代理类

• @ConfigurationProperties：贴在类或方法上

  • 是在SpringBoot解析application配置文件后，将指定前缀为jdbc的属性名的值注入到对象的同名属性中

    @ConfigurationProperties("jdbc")
    @Bean
    public MyDataSource myDataSource() {
            MyDataSource myDataSource = new MyDataSource();
            return myDataSource;
    }
    

    或

    @ConfigurationProperties("jdbc")
    public class MyDataSource {
        private String username;
        private String password;
    }
    

• @Value：配合@PropertySource一起使用，贴在属性或方法上

  • 使用${}将properties文件中值取出来，然后将值赋值给属性
  • 例如，@Value("${jdbc.driverClassName}")