@ApiModelProperty，@validated，@Data注解

最新推荐文章于 2025-05-13 09:31:29 发布

Trival_dream

最新推荐文章于 2025-05-13 09:31:29 发布

阅读量1.4k

点赞数

CC 4.0 BY-SA版权

文章标签： spring boot

本文链接：https://blog.csdn.net/Trival_dreamy/article/details/120587352

这篇博客介绍了@ApiModelProperty注解的使用，用于在API文档中提供模型属性的说明和配置，包括属性的名称、类型、是否必填和示例。同时，提到了在Spring Boot中使用@Validated进行数据校验，当数据异常时会抛出异常，便于统一处理。文章强调了数据封装的重要性，以及@Data、@Getter、@Setter等注解在简化代码中的作用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@ApiModelProperty用法

@ApiModelProperty()用于方法，字段；表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

在类中，为了增强数据的安全性和隐蔽性，通常会对数据和与数据有关的方法进行封装；

封装的步骤：

1、将类中的属性设置为private(私有的)，只能本类才能访问，其他类都访问不了，如此就对信息进行了隐藏；
2、对每个属性提供对外的公共方法访问，也就是创建一对赋取值方法(setter方法、getter方法)，用于对私有属性的访问。

因为@Data注解中包含了@Getter、@Setter、@ToString、@EqualsAndHashCode等很多注解的功能，所以可以在类上使用一个@Data注解即可；
如果只需要使用setter方法、getter方法、toString方法，可以在类上使用对应的@Getter、@Setter、@ToString注解。
————————————————
版权声明：本文为CSDN博主「taiguolaotu」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/taiguolaotu/article/details/100893767

spring-boot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。