springboot注解
本文内容纲要:
@RestController和@RequestMapping注解
我们的Example类上使用的第一个注解是@RestController。这被称为一个构造型(stereotype)注解。它为阅读代码的人们提供建议。对于Spring,该类扮演了一个特殊角色。在本示例中,我们的类是一个web@Controller,所以当处理进来的web请求时,Spring会询问它。@RequestMapping注解提供路由信息。它告诉Spring任何来自"/"路径的HTTP请求都应该被映射到home方法。@RestController注解告诉Spring以字符串的形式渲染结果,并直接返回给调用者。
注:@RestController和@RequestMapping注解是SpringMVC注解(它们不是SpringBoot的特定部分)
@EnableAutoConfiguration注解
第二个类级别的注解是@EnableAutoConfiguration。这个注解告诉SpringBoot根据添加的jar依赖猜测你想如何配置Spring。由于spring-boot-starter-web添加了Tomcat和SpringMVC,所以auto-configuration将假定你正在开发一个web应用并相应地对Spring进行设置。StarterPOMs和Auto-Configuration:设计auto-configuration的目的是更好的使用"StarterPOMs",但这两个概念没有直接的联系。你可以自由地挑选starterPOMs以外的jar依赖,并且SpringBoot将仍旧尽最大努力去自动配置你的应用。
你可以通过将@EnableAutoConfiguration或@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。
注:你只需要添加一个@EnableAutoConfiguration注解。我们建议你将它添加到主@Configuration类上。
如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。
importorg.springframework.boot.autoconfigure.*;
importorg.springframework.boot.autoconfigure.jdbc.*;
importorg.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
publicclassMyConfiguration{
}
@Configuration
SpringBoot提倡基于Java的配置。尽管你可以使用一个XML源来调用SpringApplication.run(),我们通常建议你使用@Configuration类作为主要源。一般定义main方法的类也是主要@Configuration的一个很好候选。你不需要将所有的@Configuration放进一个单独的类。@Import注解可以用来导入其他配置类。另外,你也可以使用@ComponentScan注解自动收集所有的Spring组件,包括@Configuration类。
如果你绝对需要使用基于XML的配置,我们建议你仍旧从一个@Configuration类开始。你可以使用附加的@ImportResource注解加载XML配置文件。
@Configuration注解该类,等价与XML中配置beans;用@Bean标注方法等价于XML中配置bean
@ComponentScan
你可以自由地使用任何标准的Spring框架技术去定义beans和它们注入的依赖。简单起见,我们经常使用@ComponentScan注解搜索beans,并结合@Autowired构造器注入。
如果使用上面建议的结构组织代码(将应用类放到根包下),你可以添加@ComponentScan注解而不需要任何参数。你的所有应用程序组件(@Component,@Service,@Repository,@Controller等)将被自动注册为SpringBeans。
@SpringBootApplication
很多SpringBoot开发者总是使用@Configuration,@EnableAutoConfiguration和@ComponentScan注解他们的main类。由于这些注解被如此频繁地一块使用(特别是你遵循以上最佳实践时),SpringBoot提供一个方便的@SpringBootApplication选择。
该@SpringBootApplication注解等价于以默认属性使用@Configuration,@EnableAutoConfiguration和@ComponentScan。
packagecom.example.myproject;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication//sameas@Configuration@EnableAutoConfiguration@ComponentScan
publicclassApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(Application.class,args);
}
}
@ConfigurationProperties
属性注入
@Component
@ConfigurationProperties(prefix="connection")
publicclassConnectionSettings{
privateStringusername;
privateInetAddressremoteAddress;
//...gettersandsetters
}
为了使用@ConfigurationPropertiesbeans,你可以使用与其他任何bean相同的方式注入它们
@Service
publicclassMyService{
@Autowired
privateConnectionSettingsconnection;
//...
@PostConstruct
publicvoidopenConnection(){
Serverserver=newServer();
this.connection.configure(server);
}
}
正如使用@ConfigurationProperties注解一个类,你也可以在@Bean方法上使用它。当你需要绑定属性到不受你控制的第三方组件时,这种方式非常有用。
为了从Environment属性配置一个bean,将@ConfigurationProperties添加到它的bean注册过程:
@ConfigurationProperties(prefix="foo")
@Bean
publicFooComponentfooComponent(){
...
}
和上面ConnectionSettings的示例方式相同,任何以foo为前缀的属性定义都会被映射到FooComponent上。
SpringBoot将尝试校验外部的配置,默认使用JSR-303(如果在classpath路径中)。你可以轻松的为你的@ConfigurationProperties类添加JSR-303javax.validation约束注解:
@Component
@ConfigurationProperties(prefix="connection")
publicclassConnectionSettings{
@NotNull
privateInetAddressremoteAddress;
//...gettersandsetters
}
@EnableConfigurationProperties
当@EnableConfigurationProperties注解应用到你的@Configuration时,任何被@ConfigurationProperties注解的beans将自动被Environment属性配置
你可以通过在@EnableConfigurationProperties注解中直接简单的列出属性类来快捷的注册@ConfigurationPropertiesbean的定义。
@Configuration
@EnableConfigurationProperties(ConnectionSettings.class)
publicclassMyConfiguration{
}
@Component和@Bean
@Component被用在要被自动扫描和装配的类上。@Component类中使用方法或字段时不会使用CGLIB增强(及不使用代理类:调用任何方法,使用任何变量,拿到的是原始对象)Spring注解@Component等效于@Service,@Controller,@Repository
@Bean主要被用在方法上,来显式声明要用生成的类;用@Configuration注解该类,等价与XML中配置beans;用@Bean标注方法等价于XML中配置bean。
现在项目上,本工程中的类,一般都使用@Component
来生成bean。在把通过webservice取得的类,生成Bean时,使用@Bean
和getter方法来生成bean
@Profiles
SpringProfiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记,从而限制加载它的时机。
@Configuration
@Profile("production")
publicclassProductionConfiguration{
//...
}
以正常的Spring方式,你可以使用一个spring.profiles.active的Environment属性来指定哪个配置生效。你可以使用平常的任何方式来指定该属性,例如,可以将它包含到你的application.properties中:
spring.profiles.active=dev,hsqldb
本文内容总结:
原文链接:https://www.cnblogs.com/woms/p/5754200.html