Spring Boot 常用注解汇总
<h1 id="spring-boot-常用注解汇总">Spring Boot 常用注解汇总</h1><h2 id="一启动注解-springbootapplication">一、启动注解 @SpringBootApplication</h2>
<code>@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
// ... 此处省略源码
}</code>
<p>检察源码可发现，@SpringBootApplication是一个复合注解，包含了@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan这三个注解</p>
<h3 id="springbootconfiguration-注解继承configuration注解重要用于加载设置文件">@SpringBootConfiguration 注解，继承@Configuration注解，重要用于加载设置文件</h3>
<p>@SpringBootConfiguration继承自@Configuration，二者功能也划一，标注当前类是设置类， 并会将当前类内声明的一个或多个以@Bean注解标志的方法的实例纳入到spring容器中，而且实例名就是方法名。</p>
<h3 id="enableautoconfiguration-注解开启自动设置功能">@EnableAutoConfiguration 注解，开启自动设置功能</h3>
<p>@EnableAutoConfiguration可以资助SpringBoot应用将全部符合条件的@Configuration设置都加载到当前SpringBoot创建并利用的IoC容器。借助于Spring框架原有的一个工具类：SpringFactoriesLoader的支持，@EnableAutoConfiguration可以智能的自动设置功效才得以大功告成</p>
<h3 id="componentscan-注解重要用于组件扫描和自动装配">@ComponentScan 注解，重要用于组件扫描和自动装配</h3>
<p>@ComponentScan的功能其实就是自动扫描并加载符合条件的组件或bean定义，终极将这些bean定义加载到容器中。我们可以通过basePackages等属性指定@ComponentScan自动扫描的范围，假如不指定，则默认Spring框架实现从声明@ComponentScan所在类的package进行扫描，默认情况下是不指定的，所以SpringBoot的启动类最好放在root package下。</p>
<h2 id="二controller-相关注解">二、Controller 相关注解</h2>
<h3 id="controller">@Controller</h3>
<p>控制器，处理惩罚http哀求。</p>
<h3 id="restcontroller-复合注解">@RestController 复合注解</h3>
<p>检察@RestController源码</p>
<code>@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any (or empty String otherwise)
* @since 4.0.1
*/
@AliasFor(annotation = Controller.class)
String value() default "";
}</code>
<p>从源码我们知道,@RestController注解相称于@ResponseBody+@Controller合在一起的作用,RestController利用的效果是将方法返回的对象直接在欣赏器上展示成json格式.</p>
<h3 id="requestbody">@RequestBody</h3>
<p>通过HttpMessageConverter读取Request Body并反序列化为Object（泛指）对象</p>
<h3 id="requestmapping">@RequestMapping</h3>
<p>@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 哀求映射到 MVC 和 REST 控制器的处理惩罚方法上</p>
<h3 id="getmapping用于将http-get哀求映射到特定处理惩罚程序的方法注解">@GetMapping用于将HTTP get哀求映射到特定处理惩罚程序的方法注解</h3>
<p>注解简写：@RequestMapping(value = "/say",method = RequestMethod.GET)等价于：@GetMapping(value = "/say")</p>
<p>GetMapping源码</p>
<code>@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {
//...
}</code>
<p>是@RequestMapping(method = RequestMethod.GET)的缩写</p>
<h3 id="postmapping用于将http-post哀求映射到特定处理惩罚程序的方法注解">@PostMapping用于将HTTP post哀求映射到特定处理惩罚程序的方法注解</h3>
<code>@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.POST)
public @interface PostMapping {
//...
}</code>
<p>是@RequestMapping(method = RequestMethod.POST)的缩写</p>
<h2 id="三取哀求参数值">三、取哀求参数值</h2>
<h3 id="pathvariable获取url中的数据">@PathVariable:获取url中的数据</h3>
<code>@Controller
@RequestMapping("/User")
public class HelloWorldController {
@RequestMapping("/getUser/{uid}")
public String getUser(@PathVariable("uid")Integer id, Model model) {
System.out.println("id:"+id);
return "user";
}
}</code>
<p>哀求示例：http://localhost:8080/User/getUser/123</p>
<h3 id="requestparam获取哀求参数的值">@RequestParam:获取哀求参数的值</h3>
<p>@Controller<br />
@RequestMapping("/User")<br />
public class HelloWorldController {</p>
<code>@RequestMapping("/getUser")
public String getUser(@RequestParam("uid")Integer id, Model model) {
System.out.println("id:"+id);
return "user";
}</code>
<p>}</p>
<p>哀求示例：http://localhost:8080/User/getUser?uid=123</p>
<h3 id="requestheader-把request哀求header部分的值绑定到方法的参数上">@RequestHeader 把Request哀求header部分的值绑定到方法的参数上</h3>
<h3 id="cookievalue-把request-header中关于cookie的值绑定到方法的参数上">@CookieValue 把Request header中关于cookie的值绑定到方法的参数上</h3>
<h2 id="四注入bean相关">四、注入bean相关</h2>
<h3 id="repository">@Repository</h3>
<p>DAO层注解，DAO层中接口继承JpaRepository<T,ID extends Serializable>,需要在build.gradle中引入相关jpa的一个jar自动加载。</p>
<p>Repository注解源码</p>
<code>@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any (or empty String otherwise)
*/
@AliasFor(annotation = Component.class)
String value() default "";
}</code>
<h3 id="service">@Service</h3>
<code>@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any (or empty String otherwise)
*/
@AliasFor(annotation = Component.class)
String value() default "";
}</code>
<ul>
<li>@Service是@Component注解的一个特例，作用在类上</li>
<li>@Service注解作用域默以为单例</li>
<li>利用注解设置和类路径扫描时，被@Service注解标注的类会被Spring扫描并注册为Bean</li>
<li>@Service用于标注服务层组件,表示定义一个bean</li>
<li>@Service利用时没有传参数，Bean名称默以为当前类的类名，首字母小写</li>
<li>@Service(“serviceBeanId”)或@Service(value=”serviceBeanId”)利用时传参数，利用value作为Bean名字</li>
</ul>
<h3 id="scope作用域注解">@Scope作用域注解</h3>
<p>@Scope作用在类上和方法上，用来设置 spring bean 的作用域，它标识 bean 的作用域</p>
<p>@Scope源码</p>
<code>@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scope {
/**
* Alias for {@link #scopeName}.
* @see #scopeName
*/
@AliasFor("scopeName")
String value() default "";
@AliasFor("value")
String scopeName() default "";
ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;
}</code>
<p>属性介绍</p>
<code>value
singleton 表示该bean是单例的。(默认)
prototype 表示该bean是多例的，即每次利用该bean时都会新建一个对象。
request 在一次http哀求中，一个bean对应一个实例。
session 在一个httpSession中，一个bean对应一个实例。
proxyMode
DEFAULT 不利用代理。(默认)
NO 不利用代理，等价于DEFAULT。
INTERFACES 利用基于接口的代理(jdk dynamic proxy)。
TARGET_CLASS 利用基于类的代理(cglib)。</code>
<h3 id="entity实体类注解">@Entity实体类注解</h3>
<p>@Table(name ="数据库表名")，这个注解也表明在实体类上，对应数据库中相应的表。<br />
@Id、@Column注解用于标注实体类中的字段，pk字段标注为@Id，别的@Column。</p>
<h3 id="bean产生一个bean的方法">@Bean产生一个bean的方法</h3>
<p>@Bean明确地指示了一种方法，产生一个bean的方法，而且交给Spring容器管理。支持别名@Bean("xx-name")</p>
<h3 id="autowired-自动导入">@Autowired 自动导入</h3>
<ul>
<li>@Autowired注解作用在构造函数、方法、方法参数、类字段以及注解上</li>
<li>@Autowired注解可以实现Bean的自动注入</li>
</ul>
<h3 id="component">@Component</h3>
<p>把平凡pojo实例化到spring容器中，相称于设置文件中的<bean id="" /></p>
<p>固然有了@Autowired,但是我们照旧要写一堆bean的设置文件,相称贫困,而@Component就是告诉spring,我是pojo类,把我注册到容器中吧,spring会自动提取相关信息。那么我们就不用写贫困的xml设置文件了</p>
<h2 id="五导入设置文件">五、导入设置文件</h2>
<h3 id="propertysource注解">@PropertySource注解</h3>
<p>引入单个properties文件：</p>
<p>@PropertySource(value = {"classpath : xxxx/xxx.properties"})</p>
<p>引入多个properties文件：</p>
<p>@PropertySource(value = {"classpath : xxxx/xxx.properties"，"classpath : xxxx.properties"})</p>
<h3 id="importresource导入xml设置文件">@ImportResource导入xml设置文件</h3>
<p>可以额外分为两种模式 相对路径classpath，绝对路径（真实路径）file</p>
<p>留意：单文件可以不写value或locations，value和locations都可用</p>
<p>相对路径（classpath）</p>
<ul>
<li><p>引入单个xml设置文件：@ImportSource("classpath : xxx/xxxx.xml")</p></li>
<li><p>引入多个xml设置文件：@ImportSource(locations={"classpath : xxxx.xml" , "classpath : yyyy.xml"})</p></li>
</ul>
<p>绝对路径（file）</p>
<ul>
<li><p>引入单个xml设置文件：@ImportSource(locations= {"file : d:/hellxz/dubbo.xml"})</p></li>
<li><p>引入多个xml设置文件：@ImportSource(locations= {"file : d:/hellxz/application.xml" , "file : d:/hellxz/dubbo.xml"})</p></li>
</ul>
<p>取值：利用@Value注解取设置文件中的值</p>
<p>@Value("${properties中的键}")<br />
private String xxx;</p>
<h3 id="import-导入额外的设置信息">@Import 导入额外的设置信息</h3>
<p>功能类似XML设置的，用来导入设置类，可以导入带有@Configuration注解的设置类或实现了ImportSelector/ImportBeanDefinitionRegistrar。</p>
<p>利用示例</p>
<code>@SpringBootApplication
@Import({SmsConfig.class})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}</code>
<h2 id="六事件注解-transactional">六、事件注解 @Transactional</h2>
<p>在Spring中，事件有两种实现方式，分别是编程式事件管理和声明式事件管理两种方式</p>
<ul>
<li>编程式事件管理： 编程式事件管理利用TransactionTemplate大概直接利用底层的PlatformTransactionManager。对于编程式事件管理，spring保举利用TransactionTemplate。</li>
<li>声明式事件管理： 建立在AOP之上的。其本质是对方法前后进行拦截，然后在目标方法开始之前创建大概加入一个事件，在实行完目标方法之后根据实行情况提交大概回滚事件，通过@Transactional就可以进行事件操纵，更快捷而且简朴。保举利用</li>
</ul>
<h2 id="七全局非常处理惩罚">七、全局非常处理惩罚</h2>
<h3 id="controlleradvice-同一处理惩罚非常">@ControllerAdvice 同一处理惩罚非常</h3>
<p>@ControllerAdvice 注解定义全局非常处理惩罚类</p>
<code>@ControllerAdvice
public class GlobalExceptionHandler {
}</code>
<h3 id="exceptionhandler-注解声明非常处理惩罚方法">@ExceptionHandler 注解声明非常处理惩罚方法</h3>
<code>@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
@ResponseBody
String handleException(){
return "Exception Deal!";
}
}</code>
<h2 id="八资料">八、资料</h2>
<ul>
<li>Java题目收集</li>
<li>原文地址</li>
</ul><br><br/><br/><br/><br/><br/>来源：<a href="https://www.cnblogs.com/tqlin/p/11687811.html" target="_blank">https://www.cnblogs.com/tqlin/p/11687811.html</a>
页:
[1]