博客
关于我
SpringBoot最最最常用的注解梳理
阅读量:739 次
发布时间:2019-03-21

本文共 2598 字,大约阅读时间需要 8 分钟。

注解(annotations)列表

@SpringBootApplication

包含了@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解。组件扫描功能可以自动发现Configuration类并将其加入程序上下文。

@Configuration

在Spring Boot中,@Configuration类像传统的XML配置文件,用于配置Spring应用程序。这种方式可以清楚地检查类型安全。

@EnableAutoConfiguration

自动配置功能,Spring Boot会尝试根据添加的JAR依赖自动配置应用。例如,如果HSQLDB.jar存在,并且没有手动配置数据库连接Bean,那么会自动配置一个内存型数据库。

@ComponentScan

组件扫描功能,用于自动发现和装配组件,包括@Service、@Repository等注解标记的类。默认情况下,Spring Boot会扫描启动类及其子包下使用了@Service、@Repository等注解的类。

@Component

用于标注无特定类型的组件,可以用作通用注解。当组件类型无法归类时,可以使用这个注解进行标注。

@RestController

与@Controller和@ResponseBody注解合集,表示这是一个控制器Bean,并且返回值会直接填充到HTTP响应体中,适用于RESTful APIs。

@Autowired

自动导入依赖Bean。可以用在类的成员变量、方法和构造函数上,支持required属性控制是否强制导入。

@PathVariable

用于获取URL路径变量。例如:

@RequestMapping("/user/{id}")public String getUser(@PathVariable String id){    // ...}

@JsonBackReference

解决嵌套外链问题。适用于JSON序列化场景,避免循环引用。

@RepositoryRestResource

与spring-boot-starter-data-rest配合使用,标注Rest资源。


JPA注解

@Entity

标注实体类。默认情况下会生成对应的表名。

@Table

指定实体对应的数据库表名。若表名与实体类名相同,可省略。

@MappedSuperClass

用于标注父类,确定哪些属性属于实体类的父类。

@NoRepositoryBean

用于标注父类的Repository,Spring不会创建其Bean实例。

@Column

定义数据库字段。如果字段名与列名相同,可省略。

@Id

标注主键属性。

@GeneratedValue

指定主键生成策略。例如,生成策略可以是sequence、Identity、native等。

@SequenceGenerator

定义数据库序列。例如:

@Entitypublic class Entity {    @Id    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "repair_seq")    private Long id;}

@Transient

表示属性不映射到数据库表。ORM框架会忽略该属性。

@Basic

配合@Transient使用,指定实体属性的加载方式。例如,_fetch_type可以设置为LAZY。

@JsonIgnore

在JSON序列化中忽略特定属性。序列化和反序列化都会受影响。

@JoinColumn

定义一对一关系。例如,本表的外键指向另一个表的主键列。

@OneToOne、@OneToMany、@ManyToOne

定义一对一、一对多、多对一关系,具体使用方式请参考Hibernate配置文件。


Spring MVC相关注解

@RequestMapping

用于路由映射。可以指定请求地址、参数、头、方法、提交类型、返回类型等。例如:

@RequestMapping("/api/test")public class TestController {    @RequestMapping("GET")    public String test() {        return "测试";    }}

@RequestParam

用于方法参数前。例如:

@RequestMapping("/user")public class UserController {    @Autowired    private UserRepository userRepository;    @RequestMapping("get/{id}")    public String getById(@PathVariable String id) {        System.out.println(id);        return "用户ID: " + id;    }}

@PathVariable

用于获取路径变量。例如:

@RequestMapping("user/{user_id}")public String getUserById(@PathVariable String user_id) {    // ...}

全局异常处理

@ControllerAdvice

用于标注全局异常处理类。可以被组件扫描到,并统一处理各种异常。

@ExceptionHandler

用于标注异常处理方法。例如:

@ControllerAdvicepublic class GlobalExceptionHandler {    @Autowired    private Logger logger;    @ExceptionHandler(value = Exception.class)    public String handleException(Exception e) {        logger.error("有意外错误发生,错误信息:", e.getMessage());        return "错误处理成功";    }}

转载地址:http://whprz.baihongyu.com/

你可能感兴趣的文章
Openlayers高级交互(20/20):超级数据聚合,页面不再混乱
查看>>
Openlayers高级交互(3/20):动态添加 layer 到 layerGroup,并动态删除
查看>>
Openlayers高级交互(6/20):绘制某点,判断它是否在一个电子围栏内
查看>>
Openlayers高级交互(7/20):点击某点弹出窗口,自动播放视频
查看>>
Openlayers高级交互(8/20):选取feature,平移feature
查看>>
Openlayers:DMS-DD坐标形式互相转换
查看>>
openlayers:圆孔相机根据卫星经度、纬度、高度、半径比例推算绘制地面的拍摄的区域
查看>>
OpenLDAP(2.4.3x)服务器搭建及配置说明
查看>>
OpenLDAP编译安装及配置
查看>>
Openmax IL (二)Android多媒体编解码Component
查看>>
OpenMCU(一):STM32F407 FreeRTOS移植
查看>>
OpenMCU(三):STM32F103 FreeRTOS移植
查看>>
OpenMCU(三):STM32F103 FreeRTOS移植
查看>>
OpenMCU(二):GD32E23xx FreeRTOS移植
查看>>
OpenMCU(五):STM32F103时钟树初始化分析
查看>>
OpenMCU(四):STM32F103启动汇编代码分析
查看>>
OpenMetadata 命令执行漏洞复现(CVE-2024-28255)
查看>>
OpenMMLab | S4模型详解:应对长序列建模的有效方法
查看>>
OpenMMLab | 【全网首发】Llama 3 微调项目实践与教程(XTuner 版)
查看>>
OpenMMLab | 不是吧?这么好用的开源标注工具,竟然还有人不知道…
查看>>