Spring Boot注解总结

作者：TangHanF（GuoFu）

日期：2018年4月18日

说明：转载请注明出处，谢谢！🤝

联系方式：guofu_gh@163.com

[TOC]

@RestController

@RestController表示controller里面的方法都以json格式输出，不用再写什么jackjson配置的了！

@RestController 注解告诉Spring以某种类型（例如：字符串）的形式渲染结果，并直接返回给调用者。

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

在以前的spring 开发的时候需要我们提供json接口的时候需要做那些配置呢

添加 jackjson 等相关jar包

配置spring controller扫描

对接的方法添加@ResponseBody

就这样我们会经常由于配置错误，导致406错误等等，spring boot如何做呢，只需要类添加 @RestController 即可，默认类中的方法都会以json的格式返回

@RestController
public class HelloWorldController {
    @RequestMapping("/getUser")
    public User getUser() {
        User user=new User();
        user.setUserName("小明");
        user.setPassWord("xxxx");
        return user;
    }
}

@SpringBootApplication

@SpringBootApplication是Spring Boot 项目的核心注解，主要目的是开启自动配置。main方法是一个标准的Java应用的main方法，主要作用是作为项目启动的入口。

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

@RequestMapping

提供路由信息。它告诉Spring任何来自"xxxxx"路径的HTTP请求都应该被映射到 xxxxx 方法。

注： @RestController 和 @RequestMapping 注解是Spring MVC注解（它们不是Spring Boot的特定部分）

@EnableAutoConfiguration

告诉Spring Boot根据添加的jar依赖猜测你想如何配置Spring。

由于 spring-boot-starter-web 添加了Tomcat和Spring MVC，所以auto-configuration将假定你正在开发一个web应用并相应地对Spring进行设置。Starter POMs和Auto-Configuration：设计auto-configuration的目的是更好的使用"Starter POMs"，但这两个概念没有直接的联系。你可以自由地挑选starter POMs以外的jar依赖，并且Spring Boot将仍旧尽最大努力去自动配置你的应用。

你可以通过将 @EnableAutoConfiguration 或 @SpringBootApplication 注解添加到一个 @Configuration 类上来选择自动配置。注：你只需要添加一个 @EnableAutoConfiguration 注解。我们建议你将它添加到主 @Configuration 类上。

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

1. import org.springframework.boot.autoconfigure.jdbc.*;  
2. import org.springframework.context.annotation.*;  

3. @Configuration  
4. @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})  
5. public class MyConfiguration {  
6. }

@RequestBody

返回JSON格式数据。

@ResponseBody

返回JSON格式数据。

方法、类注解。

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

以下四个顺次注解都是声明Bean对象的（功能是等效的，只是含义不一样而已）：

@Component

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

@Controller

在展现层使用。

@Service

用于标注业务层组件。

@Repository

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

@ComponentScan

组件扫描。

相当于自动扫描指定包下面所有使用 @Component @Controller @Service、Respository 等注解的类，并把这些类注册为 Bean。

@Configuration

@Configuration可理解为用spring的时候xml里面的标签

参考：@Configuration和@Bean的用法和理解

自定义Filter

我们常常在项目中会使用filters用于录调用日志、排除有XSS威胁的字符、执行权限验证等等。Spring Boot自动添加了OrderedCharacterEncodingFilter和HiddenHttpMethodFilter，并且我们可以自定义Filter。

两个步骤：

实现Filter接口，实现Filter方法

添加@Configuration 注解，将自定义Filter加入过滤链

好吧，直接上代码

@Configuration
public class WebConfiguration {
    @Bean
    public RemoteIpFilter remoteIpFilter() {
        return new RemoteIpFilter();
    }

    @Bean
    public FilterRegistrationBean testFilterRegistration() {

        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new MyFilter());
        registration.addUrlPatterns("/*");
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("MyFilter");
        registration.setOrder(1);
        return registration;
    }

    public class MyFilter implements Filter {
        @Override
        public void destroy() {
            // TODO Auto-generated method stub
        }

        @Override
        public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
                throws IOException, ServletException {
            // TODO Auto-generated method stub
            HttpServletRequest request = (HttpServletRequest) srequest;
            System.out.println("this is MyFilter,url :"+request.getRequestURI());
            filterChain.doFilter(srequest, sresponse);
        }

        @Override
        public void init(FilterConfig arg0) throws ServletException {
            // TODO Auto-generated method stub
        }
    }
}

@Bean

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

@Bean是一个方法级别上的注解，主要用在@Configuration注解的类里，也可以用在@Component注解的类里。

该Bean的名称（ID）是该被注解的方法名。

配置一个Bean：

@Configuration
public class AppConfig {
    @Bean
    public TransferService transferService() {
        return new TransferServiceImpl();
    }
}

这个配置就等同于之前在xml里的配置

<beans>
    <bean id="transferService" class="com.acme.TransferServiceImpl"/>
</beans>

@Configuration

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

标识该类是配置类。

表名该类有0个或者多个@Bean注解。

@PersistenceContext

@Scope

Scope，也称作用域，在 Spring IoC 容器是指其创建的 Bean 对象相对于其他 Bean 对象的请求可见范围。在 Spring IoC 容器中具有以下几种作用域：基本作用域（singleton、prototype），Web 作用域（reqeust、session、globalsession），自定义作用域。 1、Spring 的作用域在装配 Bean 时就必须在配置文件中指明，配置方式如下（以 xml 配置文件为例）：

<!-- 具体的作用域需要在 scope 属性中定义 -->
<bean id="XXX" class="com.XXX.XXXXX" scope="XXXX" />12

singleton：单例模式，在整个Spring IoC容器中，使用singleton定义的Bean将只有一个实例

prototype：原型模式，每次通过容器的getBean方法获取prototype定义的Bean时，都将产生一个新的Bean实例

request：对于每次HTTP请求，使用request定义的Bean都将产生一个新实例，即每次HTTP请求将会产生不同的Bean实例。只有在Web应用中使用Spring时，该作用域才有效

session：对于每次HTTP Session，使用session定义的Bean豆浆产生一个新实例。同样只有在Web应用中使用Spring时，该作用域才有效

globalsession：每个全局的HTTP Session，使用session定义的Bean都将产生一个新实例。典型情况下，仅在使用portlet context的时候有效。同样只有在Web应用中使用Spring时，该作用域才有效

　　其中比较常用的是singleton和prototype两种作用域。对于singleton作用域的Bean，每次请求该Bean都将获得相同的实例。容器负责跟踪Bean实例的状态，负责维护Bean实例的生命周期行为；如果一个Bean被设置成prototype作用域，程序每次请求该id的Bean，Spring都会新建一个Bean实例，然后返回给程序。在这种情况下，Spring容器仅仅使用new 关键字创建Bean实例，一旦创建成功，容器不在跟踪实例，也不会维护Bean实例的状态。

　　如果不指定Bean的作用域，Spring默认使用singleton作用域。Java在创建Java实例时，需要进行内存申请；销毁实例时，需要完成垃圾回收，这些工作都会导致系统开销的增加。因此，prototype作用域Bean的创建、销毁代价比较大。而singleton作用域的Bean实例一旦创建成功，可以重复使用。因此，除非必要，否则尽量避免将Bean被设置成prototype作用域。　2、基于注解开发时，@scope完成bean的作用域配置默认是单例模式（singleton）如果需要设置的话可以修改对应值与以上提到的一致例如：@scope(“prototype”)

@EnableAutoConfiguration

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

@AutoWired

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

@Qualifier

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

@Resource

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

@RequestParam

用在方法的参数前面。 @RequestParam String a =request.getParameter(“a”)。

@PathVariable

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

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

@Profiles

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

@Configuration
@Profile("prod) 
public class ProductionConfiguration { 

    // …

}

@ConfigurationProperties

Spring Boot 将尝试校验外部的配置，默认使用 JSR-303（如果在 classpath 路径中）。

@ConfigurationProperties 根据类型校验和管理 application 中的 bean。

你可以轻松的为你的 @ConfigurationProperties 类添加 JSR-303 javax.validation 约束注解：

@Component
@ConfigurationProperties(prefix="connection") 
public class ConnectionSettings {
    @NotNull 
    private InetAddress remoteAddress; 

    // ... getters and setters
}

全局异常处理

@ControllerAdvice

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

@ExceptionHandler

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

@RequestMapping 和 @GetMapping @PostMapping 区别

@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。

@PostMapping是一个组合注解，是@RequestMapping(method = RequestMethod.POST)的缩写。

Spring Boot注解总结

Spring Boot注解总结

@RestController

@SpringBootApplication

@RequestMapping

@EnableAutoConfiguration

@RequestBody

@ResponseBody

@Component

@Controller

@Service

@Repository

@ComponentScan

@Configuration

自定义Filter

@Bean

@Configuration

@PersistenceContext

@Scope

@EnableAutoConfiguration

@AutoWired

@Qualifier

@Resource

@RequestMapping

@RequestParam

@PathVariable

@Profiles

@ConfigurationProperties

全局异常处理

@ControllerAdvice

@ExceptionHandler

@RequestMapping 和 @GetMapping @PostMapping 区别

results matching ""

No results matching ""