zoukankan      html  css  js  c++  java
  • 超级全面的 SpringBoot 注解介绍,每一个用途都应该清晰

    一、注解(annotations)列表

    1、@SpringBootApplication

    包含了@ComponentScan@Configuration@EnableAutoConfiguration注解。
    其中@ComponentScanSpring Boot扫描到Configuration类并把它加入到程序上下文。

    2、@ComponentScan

    组件扫描,可自动发现和装配一些Bean

    3、@Configuration

    等同于SpringXML配置文件;使用Java代码可以检查类型安全。

    4、@EnableAutoConfiguration

    自动配置

    5、@RestController

    该注解是@Controller@ResponseBody的合集,表示这是个控制器Bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。

    6、@Autowired

    自动导入。

    7、@PathVariable

    获取参数。

    8、@JsonBackReference

    解决嵌套外链问题。

    9、@RepositoryRestResourcepublic

    配合spring-boot-starter-data-rest使用。

    二、注解(annotations)详解

    1、@SpringBootApplication:申明让Spring Boot自动给程序进行必要的配置,这个配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。

    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
    public class Application {
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    }

    2、@ResponseBody:表示该方法的返回结果直接写入HTTP Response Body中,一般在异步获取数据时使用,用于构建RESTfulapi

    在使用@RequestMapping后,返回值通常解析为跳转路径,加上@ResponseBody后返回结果不会被解析为跳转路径,而是直接写入HTTP Response Body中。

    比如异步获取json数据,加上@ResponseBody后,会直接返回json数据。

    该注解一般会配合@RequestMapping一起使用。

    示例代码:

    @RequestMapping(“/test”)
    @ResponseBody
    public String test(){
        return ”ok”;
    }

    3、@Controller:用于定义控制器类,在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)

    一般这个注解在类中,通常方法需要配合注解@RequestMapping

    示例代码:

    @Controller
    @RequestMapping(“/demoInfo”)
    publicclass DemoController {
        @Autowired
        private DemoInfoService demoInfoService;
    
        @RequestMapping("/hello")
        public String hello(Map map){
            System.out.println("DemoController.hello()");
            map.put("hello","from TemplateController.helloHtml");
            // 会使用hello.html或者hello.ftl模板进行渲染显示.
            return"/hello";
        }
    }

    4、@RestController:用于标注控制层组件(如struts中的action),@ResponseBody@Controller的合集。

    示例代码:

    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping(“/demoInfo2”)
    publicclass DemoController2 {
    
        @RequestMapping("/test")
        public String test(){
            return"ok";
        }
    }

    5、@RequestMapping:提供路由信息,负责URLController中的具体函数的映射。

    6、@EnableAutoConfigurationSpring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。

    例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。

    你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。

    如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

    搜索Java知音公众号,回复“后端面试”,送你一份Java面试题宝典.pdf

    7、@ComponentScan:表示将该类自动发现扫描组件。

    个人理解相当于,如果扫描到有@Component@Controller@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。

    我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。

    如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service@Repository等注解的类。

    8、@Configuration:相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

    9、@Import:用来导入其他配置类。

    10、@ImportResource:用来加载xml配置文件。

    11、@Autowired:自动导入依赖的bean

    12、@Service:一般用于修饰service层的组件

    13、@Repository:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。

    14、@Bean:用@Bean标注方法等价于XML中配置的bean

    15、@Value:注入Spring boot application.properties配置的属性的值。示例代码:

    @Value(value = “#{message}”)
    private String message;

    16、@Inject:等价于默认的@Autowired,只是没有required属性;

    17、@Component:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

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

    19、@AutoWired:自动导入依赖的beanbyType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

    20、@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:

    @Autowired
    @Qualifier(value = “demoInfoService”)
    private DemoInfoService demoInfoService;

    21、@Resource(name=”name”,type=”type”):没有括号内内容的话,默认byName。与@Autowired干类似的事。

    四、SpringMVC相关注解

    1、@RequestMapping@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。

    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)类型中包含该指定类型才返回。

    2、@RequestParam:用在方法的参数前面。

    3、@PathVariable:路径变量。如:

    RequestMapping(“user/get/{macAddress}”)
    public String getByMacAddress(@PathVariable String macAddress){
        //do something;
    }

    五、全局异常处理

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

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

    https://mp.weixin.qq.com/s/AweQYb1xb-G6OC8OeuJkmw

    https://mp.weixin.qq.com/s/11-228qN1k_9RQ-KT45N9g

    
    
    故乡明
  • 相关阅读:
    【Nginx学习】安装及常用命令
    【Nginx学习】基础知识
    【Nginx学习】Xshell7连接CentOS7艰难轶事
    【LeetCode刷题】5343. 多次求和构造目标数组:妙解
    【LeetCode刷题】1353. 最多可以参加的会议数目
    【转载】priority_queue用法
    【LeetCode刷题】供暖器:妙解
    【妙解】重复的子字符串
    【转载学习】基金理财学习
    【转载】sync_with_stdio + cin.tie
  • 原文地址:https://www.cnblogs.com/luweiweicode/p/14202058.html
Copyright © 2011-2022 走看看