一、核心注解
1.@Required
此注解只能用于bean的setter方法上,为了保证所对应的属性必须被设置。如果任何带有@Required的属性未设置的话 将会抛出BeanInitializationException异常
@Required
public void setProduct(Product product) {
this.product = product;
}
2.@Autowired
此注解用于bean的field、setter方法以及构造方法上,显式地声明依赖。根据type来autowiring。
(@Autowird详细说明 待完善)
@Qualifier
此注解是和@Autowired一起使用的。使用此注解可以让你对注入的过程有更多的控制。
@Qualifier可以被用在单个构造器或者方法的参数上。当上下文有几个相同类型的bean, 使用@Autowired则无法区分要绑定的bean,此时可以使用@Qualifier来指定名称。
@Component
public class User {
@Autowired
@Qualifier("address1")
private Address address;
...
}
3.@Configuration
此注解用在class上来定义bean。其作用和xml配置文件相同,表示此bean是一个Spring配置。此外,此类可以使用@Bean注解来初始化定义bean。
@Configuartion
public class SpringCoreConfig {
@Bean
public AdminUser adminUser() {
AdminUser adminUser = new AdminUser();
return adminUser;
}
}
4.@ComponentScan
指定Spring扫描注解的package。如果没有指定包,那么默认会扫描此配置类所在的package。
5. @Lazy
此注解使用在Spring的组件类上。默认的,Spring中Bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean,那么可以在此类上使用Lazy注解,表示此bean只有在第一次被使用的时候才会被创建和初始化。此注解也可以使用在被@Configuration注解的类上,表示其中所有被@Bean注解的方法都会延迟初始化。
6.@Value
此注解使用在字段、构造器参数和方法参数上。@Value可以指定属性取值的表达式,支持通过#{}使用SpringEL来取值,也支持使用${}来将属性来源中(Properties文件、本地环境变量、系统属性等)的值注入到bean的属性中。此注解值的注入发生在AutowiredAnnotationBeanPostProcessor类中
- 不通过配置文件的注入属性情况
@Value("normal")
private String normal; // 注入普通字符串
@Value("#{systemProperties['os.name']}")
private String systemPropertiesName; // 注入操作系统属性
@Value("#{ T(java.lang.Math).random() * 100.0 }")
private double randomNumber; //注入表达式结果
@Value("#{beanInject.another}")
private String fromAnotherBean; // 注入其他Bean属性:注入beanInject对象的属性another,类具体定义见下面
@Value("classpath:com/xzh/spring/configinject/config.txt")
private Resource resourceFile; // 注入文件资源
@Value("http://www.baidu.com")
private Resource testUrl; // 注入URL资源
- 通过配置文件注入
- application.properties。application.properties在spring boot启动时默认加载此文件
- 自定义属性文件。自定义属性文件通过@PropertySource加载。@PropertySource可以同时加载多个文件,也可以加载单个文件。如果相同第一个属性文件和第二属性文件存在相同key,则最后一个属性文件里的key启作用。加载文件的路径也可以配置变量,如下文的${anotherfile.configinject},此值定义在第一个属性文件config.properties
@Component
// 引入外部配置文件组:${app.configinject}的值来自config.properties。
// 如果相同
@PropertySource({"classpath:com/xzh/spring/configinject/config.properties",
"classpath:com/xzh/spring/configinject/config_${anotherfile.configinject}.properties"})
public class ConfigurationFileInject{
@Value("${app.name}")
private String appName; // 这里的值来自application.properties,spring boot启动时默认加载此文件
@Value("${book.name}")
private String bookName; // 注入配置外部文件config.properties属性
}
SpringMVC注解和Rest注解
1.@Controller
此注解使用在class上声明此类是一个Spring controller,是@Component注解的一种具体形式。
2.@RequestMapping
此注解可以用在class和method上,用来映射web请求到某一个handler类或者handler方法上。当此注解用在Class上时,就创造了一个基础url,其所有的方法上的@RequestMapping都是在此url之上的。
@Controller
@RequestMapping("/users")
public class UserController {
@RequestMapping(method = RequestMethod.GET)
public String getUserList() {
return "users";
}
}
Spring4.3后加入@RequestMapping变种
- @RequestMapping(method = RequestMethod.GET) =>>@GetMapping
- @PostMapping
- @PutMapping
- @PatchMapping
- @DeleteMapping
@RequestMapping 参数
分为三类
- (1)value 、method
- value:指定请求的实际地址,指定的地址可以是URI Template 模式;
- method: 指定请求的method类型, GET、POST、PUT、DELETE等;
- (2) consumes、produces
- consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;
//controller先接受post请求 以及"application/json"数据 @RequestMapping(value = "/testMethod", method = RequestMethod.POST,consumes="application/json")
- produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;
//返回json类型的数据 @RequestMapping(value = "/testMethod", method = RequestMethod.POST,produces="application/json") public void testMethod2(HttpServletRequest request,HttpServletResponse response,Model model) throws IOException { .... out.print(jsonobj); }
- (3)params、headers
- params: 指定request中必须包含某些参数值时,才让该方法处理。
设定必须包含username 和age两个参数,且age参数不为10 (可以有多个参数)。 @RequestMapping(value = "testParamsAndHeaders", params = { "username","age!=10" })
- headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。
@RequestMapping(value = "testParamsAndHeaders", params = { "username","age!=10" }, headers = { "Accept-Language=US,zh;q=0.8" })
@Request处理多个url
@RequestMapping(value = {
"", "/page", "page*",
"view/*,**/msg"
})
带有 @RequestParam 的 @RequestMapping
此注解用在请求handler方法的参数上,用于将http请求参数的值绑定到参数上。
@RequestMapping(value = "/id")
String getIdByValue(@RequestParam("id") String personId){}
@RequestMapping(value = "/personId")
String getId(@RequestParam String personId){}
使用 @RequestMapping 处理动态 URI
@RequestMapping 注解可以同 @PathVaraible 注解一起使用,用来处理动态的 URI,URI 的值可以作为控制器中处理方法的参数。你也可以使用正则表达式来只处理可以匹配到正则表达式的动态 URI。
@RequestMapping(value = "/student/{id}", method = RequestMethod.GET)
String getDynamicUriValue(@PathVariable String id)
@RequestMapping(value = "/student/{id:[a-z]+}/{name}", method = RequestMethod.GET)
String getDynamicUriValueRegex(@PathVariable("name") String sname)
3.CookieValue
此注解用在@RequestMapping声明的方法的参数上,可以把HTTP cookie中相应名称的cookie绑定上去。
@ReuestMapping("/cookieValue")
public void getCookieValue(@CookieValue("JSESSIONID") String cookie){
}
cookie即http请求中name为JSESSIONID的cookie值。
4.@CrossOrigin
此注解用在class和method上用来支持跨域请求,是Spring 4.2后引入的。
@CrossOrigin(maxAge = 3600)
@RestController
@RequestMapping("/users")
public class AccountController {
@CrossOrigin(origins = "http://xx.com")
@RequestMapping("/login")
public Result userLogin() {
// ...
}
}
5.@ExceptionHandler
此注解使用在方法级别,声明对Exception的处理逻辑。可以指定目标Exception。
6.@InitBinder
此注解使用在方法上,声明对WebDataBinder的初始化(绑定请求参数到JavaBean上的DataBinder)。在controller上使用此注解可以自定义请求参数的绑定。
7.@PathVariable
@PathVariable是spring3.0的一个新功能:接收请求路径中占位符的值
@RequestMapping("test/{id}/{name}")
public ModelAndView test1(@PathVariable("id") Long ids ,@PathVariable("name") String names)
8.@RequestParam
此注解用在请求handler方法的参数上,用于将http请求参数的值绑定到参数上
@RequestParam与@PathVariable的区别
在spring MVC中,两者的作用都是将request里的参数的值绑定到contorl里的方法参数里的,区别在于,URL写法不同。
使用@RequestParam时,URL是这样的:http://host:port/path?参数名=参数值
使用@PathVariable时,URL是这样的:http://host:port/path/参数值
如请求路径是127.0.0.1/student/1
@RequestMapping(value = "/student/{id}", method = RequestMethod.GET)
String getDynamicUriValue(@PathVariable String id){}
@RequestMapping(value = "/id")
String getIdByValue(@RequestParam("id") String personId){}
9.@RequestBody
此注解用在请求handler方法的参数上,用于将http请求体(如Post提交的表单数据,是存放在http的请求体中)映射绑定到此参数上。HttpMessageConverter负责将对象转换为http请求。
10.@ResponseBody
此注解用在请求handler方法上。和@RequestBody作用类似,用于将方法的返回对象转为json格式的数据输出到http响应中。
11.@RequestHeader
此注解用在请求handler方法的参数上,用于将http请求头部的值绑定到参数上
12.@RequestPart
此注解用在请求handler方法的参数上,用于将文件之类的multipart绑定到参数上。
13.@ResponseStatus
此注解用于方法和exception类上,声明此方法或者异常类返回的http状态码。可以在Controller上使用此注解,这样所有的@RequestMapping都会继承。
14.@RestController
此注解用于class上,声明此controller返回的不是一个视图而是一个领域对象。等同于@Controller+@ResponseBody两个注解。
15.@ControllerAdvice
此注解用于class上。前面说过可以对每一个controller声明一个ExceptionMethod。这里可以使用@ControllerAdvice来声明一个类来统一对所有@RequestMapping方法来做@ExceptionHandler、@InitBinder以及@ModelAttribute处理。
16.@RestControllerAdvice
此注解用于class上,同时引入了@ControllerAdvice和@ResponseBody两个注解。
17.@SessionAttribute
此注解用于方法的参数上,用于将session中的属性绑定到参数。
18.@SessionAttributes
此注解用于type级别,用于将JavaBean对象存储到session中。一般和@ModelAttribute注解一起使用。
SpringBoot注解
1.@EnableAutoConfiguration
此注解通常被用在主应用class上,告诉Spring Boot自动基于当前包添加Bean、对bean的属性进行设置等。
2.@SpringBootApplication
此注解用在Spring Boot项目的应用主类上(此类需要在base package中)。使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan。
此注解同时添加了以下几个注解:
- @Configuration
- @EnableAutoConfiguration
- @ComponentScan
Stereotype注解
1.@Component
此注解使用在class上来声明一个Spring组件(Bean), 将其加入到应用上下文中。
2.@Controller
前文已经提到过
3.@Service
此注解使用在class上,声明此类是一个服务类,执行业务逻辑、计算、调用内部api等。是@Component注解的一种具体形式。
4.@Repository
此类使用在class上声明此类用于访问数据库,一般作为DAO的角色。
此注解有自动翻译的特性,例如:当此种component抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch块
数据访问注解
1.@Transactional
此注解使用在接口定义、接口中的方法、类定义或者类中的public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,会被一些运行时基础设施来消费。
属性:
- name:当在配置文件中有多个 TransactionManager , 可以用该属性指定选择哪个事务管理器。
- propagation:事务的传播行为,默认值为 REQUIRED。
- isolation:事务的隔离度,默认值采用 DEFAULT(使用数据库同样的隔离级别)。
- timeout:事务的超时时间,默认值为-1。如果超过该时间限制但事务还没有完成,则自动回滚事务。
- read-only 指定事务是否为只读事务,默认值为 false;为了忽略那些不需要事务的方法,比如读取数据,可以设置 read-only 为 true。
- rollback-for :用于指定能够触发事务回滚的异常类型,如果有多个异常类型需要指定,各类型之间可以通过逗号分隔。
- no-rollback- for :抛出 no-rollback-for 指定的异常类型,不回滚事务。
@Transactional(rollbackFor = Exception.class)
public Long addBook(Book book
任务执行、调度注解
Scheduled
此注解使用在方法上,声明此方法被定时调度。使用了此注解的方法返回类型需要是Void,并且不能接受任何参数。
SpringBoot执行定时任务方法
@Async
此注解使用在方法上,声明此方法会在一个单独的线程中执行。不同于Scheduled注解,此注解可以接受参数。
使用此注解的方法的返回类型可以是Void也可是返回值。但是返回值的类型必须是一个Future。
SpringBoot执行异步任务
测试
1.@ContextConfiguration
此注解使用在Class上,声明测试使用的配置文件,此外,也可以指定加载上下文的类。
此注解一般需要搭配SpringJUnit4ClassRunner使用。
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringCoreConfig.class)
public class UserServiceTest {
}