@Accessors(chain = true)
链式编程,依赖于 ·Lombok
。作用在实体类上
info.setName("张三")
.setAge(18);
@Mapper
@Mapper注解是由Mybatis框架中定义的一个描述数据层接口(dao)的注解,注解往往起到的都是一个描述性作用,用于告诉spring
框架此接口的实现类由Mybatis
负责创建,并将其实现类对象存储到spring
容器中。
首先我们需要引入jar包(依赖),分别是JDBC、MYSQL、MYBATIS。
@Resource
@Resource
的作用相当于@Autowired
,只不过@Autowired
按byType自动注入,而@Resource
默认按 byName自动注入罢了。
@Resource
有两个属性是比较重要的,分是name
和type
,Spring
将@Resource
注解的name
属性解析为bean
的名字,而type
属性则解析为bean
的类型。所以如果使用name
属性,则使用byName
的自动注入策略,而使用type
属性时则使用byType
自动注入策略。
如果既不指定name
也不指定type
属性,这时将通过反射机制使用byName
自动注入策略。
@Service
@Service
注解用于类上,标记当前类是一个service类,加上该注解会将当前类自动注入到Spring
容器中,不需要再在applicationContext.xml
文件定义bean
了。
@PostMapping @GetMapping
是@RequestMapping(method = RequestMethod.POST)
,@RequestMapping(method = RequestMethod.GET)
的缩写
@PostMapping(value = "/payment/create")
public int create(@RequestBody Payment payment) {
return 1;
}
@GetMapping(value = "/payment/get/{id}")
public int getPaymentById(@PathVariable("id") Long id) {
return 1;
}
@RestController
相当于 @Controller + @ResponseBody 两个注解的结合,返回json数据不需要在方法前面加@ResponseBody注解了,但使用@RestController这个注解,就不能返回jsp,html页面,视图解析器无法解析jsp,html页面
Spring Web MVC 注解
@RequestMapping
@RequestMapping
注解的主要用途是将Web请求与请求处理类中的方法进行映射。
注解拥有以下的六个配置属性:
-
value
:映射的请求URL或者其别名 -
method
:兼容HTTP的方法名 -
params
:根据HTTP参数的存在、缺省或值对请求进行过滤 -
header
:根据HTTP Header的存在、缺省或值对请求进行过滤 -
consume
:设定在HTTP请求正文中允许使用的媒体类型 -
product
:在HTTP响应体中允许使用的媒体类型
提示:在使用@RequestMapping
之前,请求处理类还需要使用@Controller
或@RestController
进行标记
@RequestBody
@RequestBody
在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过HttpMessageConverter
传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid
注解对请求主体中的参数进行校验。
@GetMapping
@GetMapping
注解用于处理HTTP GET请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping
是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)
的快捷方式。
@PostMapping
@PostMapping
注解用于处理HTTP POST请求,并将请求映射到具体的处理方法中。@PostMapping
与@GetMapping
一样,也是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.POST)
的快捷方式。
@PutMapping
@PutMapping
注解用于处理HTTP PUT
请求,并将请求映射到具体的处理方法中,@PutMapping
是一个组合注解,相当于是@RequestMapping(method=HttpMethod.PUT)
的快捷方式。
@DeleteMapping
@DeleteMapping
注解用于处理HTTP DELETE
请求,并将请求映射到删除方法中。@DeleteMapping
是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.DELETE)
的快捷方式。
@PatchMapping
@PatchMapping
注解用于处理HTTP PATCH
请求,并将请求映射到对应的处理方法中。@PatchMapping
相当于是@RequestMapping(method=HttpMethod.PATCH)
的快捷方式。
@ControllerAdvice
@ControllerAdvice
是@Component
注解的一个延伸注解,Spring
会自动扫描并检测被@ControllerAdvice
所标注的类。@ControllerAdvice需要和@ExceptionHandler
、@InitBinder
以及@ModelAttribute
注解搭配使用,主要是用来处理控制器所抛出的异常信息。
首先,我们需要定义一个被@ControllerAdvice
所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler
注解进行标记。
此外,在有必要的时候,可以使用@InitBinder
在类中进行全局的配置,还可以使用@ModelAttribute
配置与视图相关的参数。使用@ControllerAdvice
注解,就可以快速的创建统一的,自定义的异常处理类。
@ResponseBody
@ResponseBody
会自动将控制器中方法的返回值写入到HTTP
响应中。特别的,@ResponseBody
注解只能用在被@Controller
注解标记的类中。如果在被@RestController
标记的类中,则方法不需要使用@ResponseBody
注解进行标注。@RestController
相当于是@Controller
和@ResponseBody
的组合注解。
@ExceptionHandler
@ExceptionHander
注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring
会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler
标注的方法。
@ResponseStatus
@ResponseStatus
注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS
。特别地,我们可以使用HttpStauts
类对该注解的value
属性进行赋值。
@PathVariable
@PathVariable
注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping
注解来指定URI
的模板变量,然后使用@PathVariable
注解将方法中的参数绑定到模板变量上。
@PathVariable
注解允许我们使用value
或name
属性来给参数取一个别名
模板变量名需要使用{ }进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable
中就可以省略别名的定义。
提示:如果参数是一个非必须的,可选的项,则可以在@PathVariable
中设置require = false
@RequestParam
@RequestParam
注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam
可以轻松的访问HTTP请求参数的值。
该注解的其他属性配置与@PathVariable
的配置相同,特别的,如果传递的参数为空,还可以通过defaultValue
设置一个默认值。
@Controller
@Controller
是@Component
注解的一个延伸,Spring
会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC
的控制器。下面是使用此注解的示例代码:
@RestController
@RestController
是在Spring 4.0
开始引入的,这是一个特定的控制器注解。此注解相当于@Controller
和@ResponseBody
的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody
注解。
@ModelAttribute
通过此注解,可以通过模型索引名称来访问已经存在于控制器中的model。
与@PathVariable
和@RequestParam
注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称,简写示例如下:
特别地,如果使用@ModelAttribute
对方法进行标注,Spring
会将方法的返回值绑定到具体的Model上。示例如下:
在Spring调用具体的处理方法之前,被@ModelAttribute
注解标注的所有方法都将被执行。
@CrossOrigin
@CrossOrigin
注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。使用此注解的示例如下:
@InitBinder
@InitBinder
注解用于标注初始化WebDataBinider
的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。
Spring Bean 注解
@ComponentScan
@ComponentScan
注解用于配置Spring
需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages
属性或者value
属性来配置需要扫描的包路径。value
属性是basePackages
的别名。
@Component
@Component
注解用于标注一个普通的组件类,它没有明确的业务范围,只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。此注解的使用示例如下:
@Service
@Service
注解是@Component
的一个延伸(特例),它用于标注业务逻辑类。与@Component
注解一样,被此注解标注的类,会自动被Spring
所管理。
@Repository
@Repository
注解也是@Component
注解的延伸,与@Component
注解一样,被此注解标注的类会被Spring
自动管理起来,@Repository
注解用于标注DAO
层的数据持久化类。
Spring Dependency Inject 与 Bean Scops注解
Spring DI注解
@DependsOn
@DependsOn
注解可以配置Spring IoC
容器在初始化一个Bean
之前,先初始化其他的Bean
对象。下面是此注解使用示例代码
@Bean
@Bean
注解主要的作用是告知Spring,被此注解所标注的类将需要纳入到Bean
管理工厂中。@Bean
注解的用法很简单,在这里,着重介绍@Bean
注解中initMethod
和destroyMethod
的用法。示例如下:
Scops注解
@Scope
@Scope
注解可以用来定义@Component
标注的类的作用范围以及@Bean所标记的类的作用范围。@Scope
所限定的作用范围有:singleton
、prototype
、request
、session
、globalSession
或者其他的自定义范围。这里以prototype为例子进行讲解。
当一个Spring Bean
被声明为prototype
(原型模式)时,在每次需要使用到该类的时候,Spring IoC
容器都会初始化一个新的该类的实例。在定义一个Bean
时,可以设置Bean
的scope
属性为prototype:scope=“prototype”
,也可以使用@Scope
注解设置,如下:
@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
两种不同的方式来使用@Scope
注解,示例代码如下:
@Scope 单例模式
当@Scope
的作用范围设置成Singleton
时,被此注解所标注的类只会被Spring IoC
容器初始化一次。在默认情况下,Spring IoC
容器所初始化的类实例都为singleton
。同样的原理,此情形也有两种配置方式,示例代码如下:
容器配置注解
@Autowired
@Autowired
注解用于标记Spring
将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter
方法上。
作用于构造函数
作用于setter方法
作用于字段
@Primary
当系统中需要配置多个具有相同类型的bean
时,@Primary
可以定义这些Bean
的优先级。下面将给出一个实例代码来说明这一特性:
输出结果:
this is send DingDing method message.
@PostConstruct与@PreDestroy
这两个注解不属于Spring
,它们是源于JSR-250
中的两个注解,位于common-annotations.jar
中。@PostConstruct
注解用于标注在Bean
被Spring
初始化之前需要执行的方法。@PreDestroy
注解用于标注Bean被销毁前需要执行的方法。下面是具体的示例代码:
@Qualifier
当系统中存在同一类型的多个Bean
时,@Autowired
在进行依赖注入的时候就不知道该选择哪一个实现类进行注入。此时,我们可以使用@Qualifier
注解来微调,帮助@Autowired
选择正确的依赖项。下面是一个关于此注解的代码示例:
Spring Boot注解
@SpringBootApplication
@SpringBootApplication
注解是一个快捷的配置注解,在被它标注的类中,可以定义一个或多个Bean
,并自动触发自动配置Bean
和自动扫描组件。此注解相当于@Configuration
、@EnableAutoConfiguration
和@ComponentScan
的组合。
@EnableAutoConfiguration
@EnableAutoConfiguration
注解用于通知Spring
,根据当前类路径下引入的依赖包,自动配置与这些依赖包相关的配置项。
@ConditionalOnClass与@ConditionalOnMissingClass
这两个注解属于类条件注解,它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。下面是一个简单的示例代码:
@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
//...
}
@ConditionalOnBean与@ConditionalOnMissingBean
这两个注解属于对象条件注解,根据是否存在某个对象作为依据来决定是否要执行某些配置方法。示例代码如下:
@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
//...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
//...
}
@ConditionalOnProperty
@ConditionalOnProperty
注解会根据Spring
配置文件中的配置项是否满足配置要求,从而决定是否要执行被其标注的方法。示例代码如下:
@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay alipay(){
return new Alipay();
}
@ConditionalOnResource
此注解用于检测当某个配置文件存在时,则触发被其标注的方法,下面是使用此注解的代码示例:
@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
//...
}
@ConditionalOnWebApplication与@ConditionalOnNotWebApplication
这两个注解用于判断当前的应用程序是否是Web应用程序
。如果当前应用是Web应用程序,则使用Spring WebApplicationContext
,并定义其会话的生命周期。下面是一个简单的示例:
@Bean
@ConditionalException(" && ")
LocalFileStore store(){
//...
}
@Conditional
@Conditional
注解可以控制更为复杂的配置条件。在Spring
内置的条件控制注解不满足应用需求的时候,可以使用此注解定义自定义的控制条件,以达到自定义的要求。下面是使用该注解的简单示例:
@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
//...
}