Springboot常用注解使用说明

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/xsm666/article/details/82902326

@SpringBootApplication:


这是Sprint Boot的标识,它包含@Configuration、@EnableAutoConfiguration、@ComponentScan

的作用,通常用在程序的主类上,是程序的入口。

该注解的详细原理参见:Spring Boot---(20)SpringBoot核心原理:自动化配置1

 

@RestController:

一般用在控制层,比如controller,包含@Controller和@ResponseBody,有此注解后,就不用在方法上标注@ResponseBody了,接口会自动返回json格式的数据。

 

@Service:


用于标注业务层组件。 

 

@Value


    注入spring boot application.properties配置的属性的值
    实例代码:
    @Value(value = “#{message}”)
    private String message

 

@Repository:


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

 

@ResponseBody:


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

@Component:


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

@ComponentScan:


组件扫描。相当于<context:component-scan>,如果扫描到有@Component @Controller @Service等这些注解的类,则把这些类注册为bean。

 

表示将该类自动发现(扫描)并注册到bean,可以自动收集所有的spring组件,包括@Configuration类。我们经常使用@ComponentScan注解扫描搜索beans,并结合@Autowired注解导入。如果没有配置的话,spring boot会扫描启动类所在包下以及子包下的使用@Service,@Repository等注解的类

@Configuration:

 

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

@Bean


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

@EnableAutoConfiguration:

Spring boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的spring应用。

例如:如果你的classpath下存在的HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们
 

 

@AutoWired:


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

 

@Qualifier:


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

例如:

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

 

 

@Inject


    等价于默认的@Autowired,只是没有required属性
 

@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 {
    // ...

}

 

@ExceptionHandler(Exception.class)


用在方法上面表示遇到这个异常就执行以下方法。

猜你喜欢

转载自blog.csdn.net/xsm666/article/details/82902326