目录
一、启动类注解
1.@SpringBootApplication
2.@Configuration
2.1应用场景:
2.2使用条件:
2.3 使用@Configuration和不使用的区别
2.4 @Configuration相对与@Component的区别
3.@EnableAutoConfiguration
二、Controller 相关注解
1.@Controller
2.@RestController 复合注解
3.@RequestBody
4.@RequestMapping
5.@GetMapping用于将HTTP get请求映射到特定处理程序的方法注解
6.@PostMapping用于将HTTP post请求映射到特定处理程序的方法注解
三、取请求参数值
1.@PathVariable:获取url中的数据
2.@RequestParam:获取请求参数的值
3.@RequestHeader 把Request请求header部分的值绑定到方法的参数上
4.@CookieValue 把Request header中关于cookie的值绑定到方法的参数上
四、注入bean相关
1.@Repository
2.@Service
3.@Scope作用域注解
4.@Entity实体类注解
5.@Bean产生一个bean的方法
6.@Autowired 自动导入
7.@Component
五、导入配置文件
1.@PropertySource注解
2.@ImportResource导入xml配置文件
3.@Import 导入额外的配置信息
六、事务注解 @Transactional
七、全局异常处理
1.@ControllerAdvice 统一处理异常
2.@ExceptionHandler 注解声明异常处理方法
一、启动类注解
1.@SpringBootApplication
@SpringBootApplication是一个复合注解,包含了@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan这三个注解
@SpringBootConfiguration继承自@Configuration,二者功能也一致,标注当前类是配置类, 并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中,并且实例名就是方法名。
@EnableAutoConfiguration 注解,开启自动配置功能
@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成
@ComponentScan 注解,主要用于组件扫描和自动装配
@ComponentScan的功能其实就是自动扫描并加载符合条件的组件或bean定义,最终将这些bean定义加载到容器中。我们可以通过basePackages等属性指定@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现从声明@ComponentScan所在类的package进行扫描,默认情况下是不指定的,所以SpringBoot的启动类最好放在root package下。
2.@Configuration
用于标识一个类是配置类,相当于xml文件中的<bean></bean>
2.1应用场景:
- 搭配@Bean实现注入
- 搭配@Component实现注入
- 引入其他注解配置或者xml文件
- 其他
2.2使用条件:
- @Configuration不可以是final类型;
- @Configuration不可以是匿名类;
- 嵌套的configuration必须是静态类。
2.3 使用@Configuration和不使用的区别
不使用@Configuration的情况下,如果存在循环
@ComponentScan("com.xxx")
//@Configuration
public class Config {
@Bean
public A a() {
return new A(B());
}
@Bean
public B b() {
return new B();
}
}
public class A {
public A(B b) {
System.out.println("A");
}
}
@Component
public class B {
public B() {
System.out.println("B");
}
}
添加了@Configuration时打印 AB
不添加时打印BAB
原因:添加了@Configuration的类会使用cglib进行创建,cglib动态代理的作用是在实例化@Bean对象的时候判断@Bean对象是否已经创建,如果已经创建成功,则从spring容器中获取,不再新建。
2.4 @Configuration相对与@Component的区别
Spring把实例化分成两种模式,分别是full模式和lite模式
lite模式和full模式的区别or优缺点
- 动态代理:full模式下spring会为类创建动态代理类,而lite模式不会
- 单例多例:full模式可以保证@Bean是单例,而lite不保证一定是单例
- 创建的类型:full模式不允许@Bean方法使用private/final等进行修饰,而lite模式的类会被当成普通类创建
- 性能:full模式因为要创建动态代理类,因此性能上回比lite模式低
哪些是lite模式
- 类上标注有@Component注解
- 类上标注有@ComponentScan注解
- 类上标注有@Import注解
- 类上标注有@ImportResource注解
- 若类上没有任何注解,但类内存在@Bean方法
哪些是full模式
- 使用了@Configuration注解的类
3.@EnableAutoConfiguration
@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
...
}
@EnableAutoConfiguration是由多个注解组成,不过比较重要的是@Import(EnableAutoConfigurationImportSelector.class)
EnableAutoConfigurationImportSelector使用SpringFactoriesLoader.loadFactories方法通过反射的机制会去加载所有jar包下面的META-INF/spring.factories文件里面org.springframework.boot.autoconfigure.EnableAutoConfiguration对应的类
二、Controller 相关注解
1.@Controller
控制器,处理http请求。
2.@RestController 复合注解
查看@RestController源码
@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 "";
}
从源码我们知道,@RestController注解相当于@ResponseBody+@Controller合在一起的作用,RestController使用的效果是将方法返回的对象直接在浏览器上展示成json格式.
3.@RequestBody
通过HttpMessageConverter读取Request Body并反序列化为Object(泛指)对象
4.@RequestMapping
@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上
5.@GetMapping用于将HTTP get请求映射到特定处理程序的方法注解
注解简写:@RequestMapping(value = "/say",method = RequestMethod.GET)等价于:@GetMapping(value = "/say")
GetMapping源码
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {
//...
}
是@RequestMapping(method = RequestMethod.GET)的缩写
6.@PostMapping用于将HTTP post请求映射到特定处理程序的方法注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.POST)
public @interface PostMapping {
//...
}
是@RequestMapping(method = RequestMethod.POST)的缩写
三、取请求参数值
1.@PathVariable:获取url中的数据
@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";
}
}
请求示例:http://localhost:8080/User/getUser/123
2.@RequestParam:获取请求参数的值
@Controller
@RequestMapping("/User")
public class HelloWorldController {
@RequestMapping("/getUser")
public String getUser(@RequestParam("uid")Integer id, Model model) {
System.out.println("id:"+id);
return "user";
}
}
请求示例:http://localhost:8080/User/getUser?uid=123
3.@RequestHeader 把Request请求header部分的值绑定到方法的参数上
4.@CookieValue 把Request header中关于cookie的值绑定到方法的参数上
四、注入bean相关
1.@Repository
DAO层注解,DAO层中接口继承JpaRepository<T,ID extends Serializable>,需要在build.gradle中引入相关jpa的一个jar自动加载。
2.@Service
- @Service是@Component注解的一个特例,作用在类上
- @Service注解作用域默认为单例
- 使用注解配置和类路径扫描时,被@Service注解标注的类会被Spring扫描并注册为Bean
- @Service用于标注服务层组件,表示定义一个bean
- @Service使用时没有传参数,Bean名称默认为当前类的类名,首字母小写
- @Service(“serviceBeanId”)或@Service(value=”serviceBeanId”)使用时传参数,使用value作为Bean名字
3.@Scope作用域注解
@Scope作用在类上和方法上,用来配置 spring bean 的作用域,它标识 bean 的作用域
@Scope源码
@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;
}
属性介绍
value
singleton 表示该bean是单例的。(默认)
prototype 表示该bean是多例的,即每次使用该bean时都会新建一个对象。
request 在一次http请求中,一个bean对应一个实例。
session 在一个httpSession中,一个bean对应一个实例。
proxyMode
DEFAULT 不使用代理。(默认)
NO 不使用代理,等价于DEFAULT。
INTERFACES 使用基于接口的代理(jdk dynamic proxy)。
TARGET_CLASS 使用基于类的代理(cglib)。
4.@Entity实体类注解
@Table(name ="数据库表名"),这个注解也注释在实体类上,对应数据库中相应的表。
@Id、@Column注解用于标注实体类中的字段,pk字段标注为@Id,其余@Column。
5.@Bean产生一个bean的方法
@Bean明确地指示了一种方法,产生一个bean的方法,并且交给Spring容器管理。支持别名@Bean("xx-name")
6.@Autowired 自动导入
- @Autowired注解作用在构造函数、方法、方法参数、类字段以及注解上
- @Autowired注解可以实现Bean的自动注入
7.@Component
把普通pojo实例化到spring容器中,相当于配置文件中的
虽然有了@Autowired,但是我们还是要写一堆bean的配置文件,相当麻烦,而@Component就是告诉spring,我是pojo类,把我注册到容器中吧,spring会自动提取相关信息。那么我们就不用写麻烦的xml配置文件了
五、导入配置文件
1.@PropertySource注解
引入单个properties文件:
@PropertySource(value = {"classpath : xxxx/xxx.properties"})
引入多个properties文件:
@PropertySource(value = {"classpath : xxxx/xxx.properties","classpath : xxxx.properties"})
2.@ImportResource导入xml配置文件
可以额外分为两种模式 相对路径classpath,绝对路径(真实路径)file
注意:单文件可以不写value或locations,value和locations都可用
相对路径(classpath)
- 引入单个xml配置文件:@ImportSource("classpath : xxx/xxxx.xml")
- 引入多个xml配置文件:@ImportSource(locations={"classpath : xxxx.xml" , "classpath : yyyy.xml"})
绝对路径(file)
- 引入单个xml配置文件:@ImportSource(locations= {"file : d:/hellxz/dubbo.xml"})
- 引入多个xml配置文件:@ImportSource(locations= {"file : d:/hellxz/application.xml" , "file : d:/hellxz/dubbo.xml"})
取值:使用@Value注解取配置文件中的值
@Value("${properties中的键}")
private String xxx;
3.@Import 导入额外的配置信息
功能类似XML配置的,用来导入配置类,可以导入带有@Configuration注解的配置类或实现了ImportSelector/ImportBeanDefinitionRegistrar。
使用示例
@SpringBootApplication
@Import({SmsConfig.class})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
六、事务注解 @Transactional
在Spring中,事务有两种实现方式,分别是编程式事务管理和声明式事务管理两种方式
- 编程式事务管理: 编程式事务管理使用TransactionTemplate或者直接使用底层的PlatformTransactionManager。对于编程式事务管理,spring推荐使用TransactionTemplate。
- 声明式事务管理: 建立在AOP之上的。其本质是对方法前后进行拦截,然后在目标方法开始之前创建或者加入一个事务,在执行完目标方法之后根据执行情况提交或者回滚事务,通过@Transactional就可以进行事务操作,更快捷而且简单。推荐使用
七、全局异常处理
1.@ControllerAdvice 统一处理异常
@ControllerAdvice 注解定义全局异常处理类
@ControllerAdvice
public class GlobalExceptionHandler {
}
2.@ExceptionHandler 注解声明异常处理方法
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
@ResponseBody
String handleException(){
return "Exception Deal!";
}
}