SpringBoot常用注解

SpringBoot常用注解

目录

SpringBoot常用注解

（一）使用注解的优势

（二）常用注解

1.@SpringBootApplication

2.@RestController

3.组件类注解

4.JPA注解

5.其他注解

 

---

---

（一）使用注解的优势

     1.采用纯java代码，不在需要配置繁杂的xml文件

     2.在配置中也可享受面向对象带来的好处

     3.类型安全对重构可以提供良好的支持

     4.减少复杂配置文件的同时亦能享受到springIoC容器提供的功能

---

（二）常用注解

1.@SpringBootApplication

申明让spring boot自动给程序进行必要的配置，这个配置等同于:

(1)@Configuration  等同于spring的XML配置文件,使用Java代码可以检查类型安全

(2)@EnableAutoConfiguration 自动配置

(3)@ComponentScan 让spring Boot扫描到Configuration类并把它加入到程序上下文，组件扫描，可自动发现和装配一些Bean

 

2.@RestController

用于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集

(1)@Controller 用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping

(2)@ResponseBody 表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@Responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。

(3)@RequestMapping 提供路由信息，负责URL到Controller中的具体函数的映射

• value，指定请求的地址
• method 请求方法类型 这个不写的话，自适应：get或者post
• consumes 请求的提交内容类型
• produces 指定返回的内容类型 仅当request请求头中的(Accept)类型中包含该指定类型才返回
• params 指定request中必须包含某些参数值
• headers 指定request中必须包含指定的header值

(4)@RequestHeader 获取Header

(5)@RequestParam 获取参数

 

3.组件类注解

(1)@Component: 标准一个普通的spring Bean类

(2)@Repository：标注一个DAO组件类

(3)@Service: 标注一个业务逻辑组件类

(4)@Controller: 标注一个控制器组件类

 

4.JPA注解

(1)@Entity：@Table(name=”“)  表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

(2)@MappedSuperClass: 用在确定是父类的entity上。父类的属性子类可以继承

(3)@NoRepositoryBean: 一般用作父类的repository,spring不会去实例化该repository

(4)@Column: 如果字段名与列名相同，则可以省略

(5)@Id：表示该属性为主键

(6)@Transient: 表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性

(7)@OneToOne、@OneToMany、@ManyToOne: 对应hibernate配置文件中的一对一，一对多，多对一

 

5.其他注解

(1) @Import: 用来导入其他配置类

(2)@ImportResource: 用来加载xml配置文件

(3)@Autowired: 自动导入依赖的bean

(4)@Bean: 用@Bean标注方法等价于XML中配置的bean

(5)@Value: 注入Spring boot application.properties配置的属性的值

(6)@Inject: 等价于默认的@Autowired，只是没有required属性

(7)@Resource(name=”name”,type=”type”): 没有括号内内容的话，默认byName。与@Autowired干类似的事

(8)@PathVariable: 获取参数

(9)@Scope：注解在类上，描述spring容器如何创建Bean实例

• singleton： 表示在spring容器中的单例，通过spring容器获得该bean时总是返回唯一的实例
• prototype：表示每次获得bean都会生成一个新的对象
• request：表示在一次http请求内有效（只适用于web应用）
• session：表示在一个用户会话内有效（只适用于web应用）
• globalSession：表示在全局会话内有效（只适用于web应用）