SpringBoot常见的注解
启动类
@SpringBootApplication:标记一个主类作为Spring Boot应用的入口。
@SpringBootConfiguration:标记一个类作为Spring Boot的配置类。
@EnableAutoConfiguration:用于开启自动配置功能。
@ComponentScan:用于指定需要扫描的包路径。
@AutoConfigurationPackage:用于指定自动配置的包路径。
@Import:用于导入其他配置类。
@EnableTransactionManagement:用于开启事务管理功能。
@Slf4j:标记一个类或方法需要使用SLF4J日志接口。
@EnableAspectJAutoProxy:用于开启AspectJ自动代理功能。
@EnableOpenApi:用于开启OpenAPI功能。
@EnableScheduling:用于开启定时任务功能。
@MapperScan:MyBatis框架中的一个注解,用于指定扫描的Mapper接口所在的包路径。
@EnableSwagger2:用于开启Swagger 2功能。
配置类
@Configuration:标记一个类为Spring框架中的配置类。
@Bean:标记一个方法为Spring框架中的Bean定义。
@Aspect:标记一个类为切面(Aspect)。
@PointCut:用于定义切点表达式。它通常与@Aspect注解一起使用,以表示该切面中哪些方法需要进行拦截和处理。
@Before:用于标记方法执行前的前置操作。
@After:用于标记方法执行后的后置操作。
@AfterThrowing:用于标记方法抛出异常时执行的后置操作。
@AfterReturning:当被方法返回时执行的后置操作。
@Around:用于标记一个方法执行前后的环绕通知
@Value:用于注入配置文件中的属性值。
数据访问层
@Repository:用于标记一个类为数据访问层。
@Mapper:MyBatis框架中的一个注解,用于标记一个接口为MyBatis的Mapper接口。
@Insert:MyBatis框架中的一个注解,用于标记一个方法为插入操作。
@Delete:MyBatis框架中的一个注解,用于标记一个方法为删除操作。
@Update:MyBatis框架中的一个注解,用于标记一个方法为更新操作。
@Select:MyBatis框架中的一个注解,用于标记一个方法为查询操作。
@Results:MyBatis框架中的一个注解,指定查询结果映射到哪个Java对象中。
@Result:MyBatis框架中的一个注解,并将查询结果映射到指定的Java对象中。
@Param:MyBatis框架中的一个注解,用于指定SQL语句中的参数占位符。
@Data:是Lombok库中的一个注解,用于自动生成Java类中的getter、setter、equals、hashCode和toString等方法。
@NoArgsConstructor:是Lombok库中的一个注解,用于自动生成一个无参构造函数。
@AllArgsConstructor:是Lombok库中的一个注解,用于自动生成一个包含所有成员变量的构造函数。
@Excel:主要用于处理Excel相关的操作。
@ApiModelProperty:是Swagger框架中的一个注解,用于描述API模型的属性。
Spring Boot 整合 JpaRepository
@Entity:用于标记一个类为实体类。在JPA中,实体类表示数据库中的表,并且每个实体类的属性对应表中的列。
@Table:用于指定实体类与数据库表之间的映射关系。它通常与@Entity注解一起使用,以表示该类是一个数据库表的实体类。
@Id:用于标记实体类中的主键属性。它通常与@Entity注解一起使用,以表示该属性是一个数据库表的主键。
@GeneratedValue:用于指定主键的生成策略。它通常与@Id注解一起使用,以自动生成主键值。
@Column:用于指定实体类属性与数据库表中列之间的映射关系。它通常与@Entity注解一起使用,以表示该属性是一个数据库表的列。
业务层
@Service:用于标记一个类为业务层组件。
@Transactional:用于声明一个方法需要进行事务管理。当一个方法被标记为@Transactional
时,Spring会自动为其创建一个事务代理对象,并在方法执行前后进行事务的提交和回滚操作。这样可以确保方法执行过程中的数据一致性。
@Async:用于声明一个方法需要进行异步执行。
@Scheduled:用于声明一个方法需要进行定时执行。
@Resource:用于注入依赖(根据名字注入)。
@Autowired:用于自动装配依赖(根据类型注入)。
@Qualifier:用于指定需要注入的Bean的名称。常与@Autowired配合使用
Web层
@Controller:用于标记一个类为控制器
@RestController:用于标记一个类为RESTful风格的控制器(Controller)。RESTful风格的控制器使用HTTP方法(如GET、POST、PUT、DELETE等)来处理用户请求,并返回JSON格式的响应。
@ResponseBody:用于将控制器方法的返回值直接写入HTTP响应体中。当使用@RestController
注解时,可以将方法的返回值自动转换为JSON格式并写入响应体中。
@RequestMapping:用于映射HTTP请求到特定的处理方法
@GetMapping:用于映射HTTP GET请求到特定的处理方法。
@PostMapping: 用于映射HTTP POST请求到特定的处理方法。
@DeleteMapping:用于映射HTTP DELETE请求到特定的处理方法
@UpdateMapping:是一个用于处理 HTTP PUT 请求的注解。
@RequestParam:用于处理 HTTP 请求参数。
@PathVariable:用于处理 URL 路径中的变量。
@RequestBody:用于处理 HTTP 请求体中的数据。
测试类
@SpringBootTest:用于标记一个测试类。
@Test:用于标记一个测试方法。
其他
@Component:用于标记一个类为 Spring 组件。
完结
待续...