【java】springboot常用注解

博主：本当迷
发布时间：2022 年 08 月 02 日
915 次浏览
暂无评论
4796字数
分类： java

## 声明Bean的注解有：

* @Component 没有明确角色的组件
* @Service 在业务逻辑层（Service层）使用
* @Repositpry 在数据访问层（dao层）使用
* @Controller 用于标注控制层组件
* @RestController

## 常用注解说明

### @SpringBootApplication：

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

`@Configuration `，`@EnableAutoConfiguration` 和 `@ComponentScan `三个配置。

### @ResponseBody：

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

### @Controller：

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

### @RestController：

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

### @RestControllerAdvice与@ControllerAdvice

两个注解的作用基本上是一致的，都是为了实现`自定义全局异常处理，`

@RestControllerAdvice注解包含了@ControllerAdvice注解和@ResponseBody注解。

所以@RestControllerAdvice还可以处理json数据

### @RequestMapping：

提供路由信息，负责URL到Controller中的具体函数的映射。

### @EnableAutoConfiguration：

SpringBoot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置你的Spring应用。例如，如果你的classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库”。你可以将`@EnableAutoConfiguration`或者`@SpringBootApplication`注解添加到一个`@Configuration`类上来选择自动配置。如果发现应用了你不想要的特定自动配置类，你可以使用`@EnableAutoConfiguration`注解的排除属性来禁用它们。

### @ComponentScan：

表示将该类自动发现扫描组件。个人理解相当于，如果扫描到有`@Component`、`@Controller`、`@Service`等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用`@ComponentScan`注解搜索beans，并结合`@Autowired`注解导入。可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。如果没有配置的话，Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

```java
@ComponentScan(“com.demo”)
@SpringBootApplication
public class SpringbootApplication {

```

### @ServletComponentScan注解的作用

在SpringBootApplication上使用@ServletComponentScan注解后，
Servlet（控制器）、Filter（过滤器）、Listener（监听器）可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册到Spring容器中，无需其他代码。

### @Configuration：

相当于传统的xml配置文件，如果有些第三方库需要用到xml文件，建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

### @ConfigurationProperties

用于封装yml文件中的数据对象

![](https://www.bdmcom.cn/usr/uploads/2022/08/4023302987.png)

### @Import：

用来导入其他配置类。

### @ImportResource：

用来加载xml配置文件。

### @Autowired：

自动导入依赖的bean

### @Service：

一般用于修饰service层的组件

### @Repository：

使用`@Repository`注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。

### @Bean：

用@Bean标注方法等价于XML中配置的bean。

### @Value：

1、注入Spring boot application.properties配置的属性的值。

2、读取yam格式数据

### @Inject：

等价于默认的@Autowired，只是没有required属性；

### @Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

### @Bean:

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

### @AutoWired：

自动导入依赖的bean。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错。

### @Qualifier：

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：

### @Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。与@Autowired干类似的事。

## 二、注解列表如下

`@SpringBootApplication`：包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中

`@ComponentScan`：让spring Boot扫描到Configuration类并把它加入到程序上下文。

`@Configuration `：等同于spring的XML配置文件；使用Java代码可以检查类型安全。

`@EnableAutoConfiguration` ：自动配置。

`@ComponentScan` ：组件扫描，可自动发现和装配一些Bean。

`@Component`可配合CommandLineRunner使用，在程序启动后执行一些基础任务。

`@RestController`：注解是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。

`@Autowired`：自动导入。

`@PathVariable`：获取参数。

`@JsonBackReference`：解决嵌套外链问题。

`@RepositoryRestResourcepublic`：配合spring-boot-starter-data-rest使用。

## 三、JPA注解

### @Entity：@Table(name=”“)：

表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

### @MappedSuperClass:

用在确定是父类的entity上。父类的属性子类可以继承。

### @NoRepositoryBean:

一般用作父类的repository，有这个注解，spring不会去实例化该repository。

### @Column：

如果字段名与列名相同，则可以省略。

### @Id：

表示该属性为主键。

### @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名称，两个名称可以一致。

### @Transient：

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载方式

### @JsonIgnore：

作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn（name=”loginId”）:一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。

最后修改：2022 年 08 月 06 日

如果文章有用，请随意打赏。

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

【java】springboot常用注解

本当迷 • 2022 年 08 月 02 日

## 声明Bean的注解有：

## 常用注解说明

### @SpringBootApplication：

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

`@Configuration `，`@EnableAutoConfiguration` 和 `@ComponentScan `三个配置。

### @ResponseBody：

### @Controller：

### @RestController：

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

### @RestControllerAdvice与@ControllerAdvice

两个注解的作用基本上是一致的，都是为了实现`自定义全局异常处理，`

@RestControllerAdvice注解包含了@ControllerAdvice注解和@ResponseBody注解。

所以@RestControllerAdvice还可以处理json数据

### @RequestMapping：

提供路由信息，负责URL到Controller中的具体函数的映射。

### @EnableAutoConfiguration：

### @ComponentScan：

```java
@ComponentScan(“com.demo”)
@SpringBootApplication
public class SpringbootApplication {

```

### @ServletComponentScan注解的作用

### @Configuration：

### @ConfigurationProperties

用于封装yml文件中的数据对象

![](https://www.bdmcom.cn/usr/uploads/2022/08/4023302987.png)

### @Import：

用来导入其他配置类。

### @ImportResource：

用来加载xml配置文件。

### @Autowired：

自动导入依赖的bean

### @Service：

一般用于修饰service层的组件

### @Repository：

### @Bean：

用@Bean标注方法等价于XML中配置的bean。

### @Value：

1、注入Spring boot application.properties配置的属性的值。

2、读取yam格式数据

### @Inject：

等价于默认的@Autowired，只是没有required属性；

### @Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

### @Bean:

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

### @AutoWired：

### @Qualifier：

### @Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。与@Autowired干类似的事。

## 二、注解列表如下

`@SpringBootApplication`：包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中

`@ComponentScan`：让spring Boot扫描到Configuration类并把它加入到程序上下文。

`@Configuration `：等同于spring的XML配置文件；使用Java代码可以检查类型安全。

`@EnableAutoConfiguration` ：自动配置。

`@ComponentScan` ：组件扫描，可自动发现和装配一些Bean。

`@Component`可配合CommandLineRunner使用，在程序启动后执行一些基础任务。

`@RestController`：注解是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。

`@Autowired`：自动导入。

`@PathVariable`：获取参数。

`@JsonBackReference`：解决嵌套外链问题。

`@RepositoryRestResourcepublic`：配合spring-boot-starter-data-rest使用。

## 三、JPA注解

### @Entity：@Table(name=”“)：

表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

### @MappedSuperClass:

用在确定是父类的entity上。父类的属性子类可以继承。

### @NoRepositoryBean:

一般用作父类的repository，有这个注解，spring不会去实例化该repository。

### @Column：

如果字段名与列名相同，则可以省略。

### @Id：

表示该属性为主键。

### @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名称，两个名称可以一致。

### @Transient：

### @JsonIgnore：

作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn（name=”loginId”）:一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。

【java】springboot常用注解

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

【修仙之路】JAVA学习路线

对于异或运算的初步认识与auto用法

【JAVA经典例题】生产者/消费者问题

最近某音挺火的代码实现爱心形状

再见Swagger！拥抱smart-doc无侵入生成接口文档

STL初识-queue容器

【mysql】低版本数据库导入高版本数据库sql报错

springboot集成swagger2

删除有序数组中的重复项

【瞎搞】本当迷计算器

【java】springboot常用注解

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

【java】springboot常用注解

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款