SpringBoot常见注解
2021-03-30 18:27
在使用SpringBoot的过程中,几乎没有了XML配置,采用注解+JavaConfig方式开发,这样做的好处是:
- 采用纯java代码,不在需要配置繁杂的xml文件
- 在配置中也可享受面向对象带来的好处
- 类型安全对重构可以提供良好的支持
- 减少复杂配置文件的同时亦能享受到springIoC容器提供的功能
@SpringBootApplication
这个注解很常见了,每次在启动SpringBoot项目的时候,都会见到它,它作用在类上,标识该类为SpringBoot项目启动类。
并且让SpringBoot自动给程序进行必要的配置,等同于@Configuration、@EnableAutoConfiguration、@ComponentScan这三个注解。
@Configuration
- 相当于传统Spring的xml配置文件。
- 如果第三方库需要用到xml文件,建议通过@Configuration类作为项目的配置主类,可以使用@ImportResource注解加载xml配置文件。
@EnableAutoConfiguration 自动配置。
- SpringBoot自动配置(auto-configuration),尝试根据你添加的启动器(starter)自动配置你的SpringBoot应用。
- 你可以将@EnableAutoConfiguration注解或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。
- 如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。
@ComponentScan
- 如果某个类加上@ComponentScan注解,则该类会自动发现扫描组件。
- 也就是说,如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。
- 我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,SpringBoot会扫描启动类所在包下以及子包下的使用了@Component、@Controller、@Service、@Repository等注解的类。
@Controller
- @Controller注解用于定义控制器类,在SpringBoot中由控制器负责将用户发来的URL请求转发到对应的服务接口(Controller层)。
- 一般这个注解用在类上,控制器方法需要加上@RequestMapping注解。
@ResponseBody
- 如果控制器方法加上@ResponseBody注解,该方法的返回结果将直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。
- 在使用@RequestMapping后,返回值通常解析为跳转路径,加上@esponsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。
- 比如异步获取json数据,加上@Responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。
@RestController
- @RestController注解是@Controller和@ResponseBody的合集。
- 使用在类上,表示该类是控制器,并且类中所有控制器方法的返回值直接填入HTTP响应体中,是RESTful风格的控制器,控制器方法返回JSON数据。
@RequestMapping
提供路由信息,负责URL到Controller中的具体方法的映射。
@Import
用来导入其他配置类(加了@Configuration注解的类)。
@ImportResource
用来加载xml配置文件。
@PathVariable
获取URL上的参数(Restful风格接口)。
@Service
一般用于修饰service层的组件
@Repository
使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
@Bean
用@Bean标注方法等价于XML中配置的bean,意思是产生一个bean,并交给SpringBoot管理。
@Value
注入SpringBoot中的配置文件——application.properties配置的属性的值。
@Inject
等价于默认的@Autowired,只是没有required属性。
@Component
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@AutoWired
自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。
@Qualifier
当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者。
@Resource(name=”name”,type=”type”)
没有括号内内容的话,默认byName。与@Autowired干类似的事。
@JsonBackReference
解决嵌套外链问题。
@RepositoryRestResourcepublic
配合spring-boot-starter-data-rest使用。
全局异常注解
@ControllerAdvice
包含@Component,可以被扫描到。统一处理异常。
@ExceptionHandler(Exception.class)
用在方法上面表示遇到这个异常就执行以下方法。
JPA注解
JPA是ORM思想的规范接口,存在两个核心:
- 建立表与实体类的映射。
- 建立表字段与实体类属性映射,操作实体类就是操作表。
Hibernate框架作为JPA的实现者之一。
@Entity&@Table(name="表名")
@Entity注解表明这是一个实体类。
@Table(name="表名")映射一张表,但是如果表名和实体类名相同的话,@Table可以省略。
@MappedSuperClass
用在确定是父类的entity上。父类的属性子类可以继承。
@NoRepositoryBean
一般用作父类的repository,有这个注解,SpringBoot不会去实例化该repository。
@Column
建立表字段与实体类属性映射,如果字段名与列名相同,则可以省略。
@Id
表示该属性为主键。
@Transient
- 表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。
- 如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。
@Basic
@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式
@GeneratedValue
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq。
@SequenceGeneretor
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。
@JsonIgnore
作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。
@OneToOne、@OneToMany、@ManyToOne
对应多表之间的一对一,一对多,多对一关系。