Java 通过反射获取实体类对应的注释

路漫漫,其修远兮

已于 2024-10-24 11:30:59 修改

阅读量2.7k

点赞数 1

于 2023-06-13 11:48:37 首次发布

本文链接：https://blog.youkuaiyun.com/m0_66572126/article/details/131184912

版权

文章介绍了如何引入swagger依赖来使用@ApiModelProperty注解获取和处理实体类的注释信息，通过在实体类的字段上添加此注解，然后在main方法中遍历并提取这些注解的值，以生成API文档所需的字段描述。

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

一、使用@ApiModelProperty 获取注释信息需要引入 swagger 依赖

①先引入swagger依赖

在 Maven 项目中引入 Swagger 依赖是第一步，目的是为了能够使用 Swagger 的注解，如 @ApiModelProperty。这是必要的，因为没有这些依赖，编译器将无法识别这些注解。

    <dependency>
		<groupId>com.spring4all</groupId>
		<artifactId>swagger-spring-boot-starter</artifactId>
		<version>1.9.1.RELEASE</version>
	</dependency>

②准备实体类注意(swagger 依赖没有加载无法使用@ApiModelProperty 注解)

在这个例子中，我们定义了一个名为 OrderCsv 的 Java 类。这个类实现了 Serializable 接口，表示它的对象可以被序列化。我们使用 @Data 注解（通常来自 Lombok）来自动生成 getter 和 setter 方法。

@Data
public class OrderCsv implements Serializable {

    /**
     * 名称
     */
    @ApiModelProperty("名称")
    private String name;

    /**
     * 年龄
     */
    @ApiModelProperty("年龄")
    private String age;

    /**
     * id
     */
    @ApiModelProperty("id")
    private String id;
}

详细字段解释

@ApiModelProperty("名称")：这个注解为 name 字段添加描述。Swagger 将使用这个描述生成 API 文档。
private String name;：这是字段的声明，private 修饰符表示该字段只能在 OrderCsv 类内部访问。

二、具体方法使用main方法测试

 public static void main(String[] args) {
        //获取对象 属性注释 准备集合接收 字段注释
        List<String> list = new ArrayList<>();
        //加载类
        Class<OrderCsv> orderDtoClass = OrderCsv.class;
        /*
         * 1.getDeclaredFields 获取当前类的所有字段,包括protected/默认/private修饰的字段;不包括父类public修饰的字段
         * 2.getFields 方法获取当前类或父接口的public修饰的字段 
         *  当前使用1就ok 根据需要修改方法
         */
        Field[] declaredFields = orderDtoClass.getDeclaredFields();
        //遍历数据
        for (Field declaredField : declaredFields) {
            //isAnnotationPresent 查看当前字段是否加有@ApiModelProperty注解
            boolean annotation = declaredField.isAnnotationPresent(ApiModelProperty.class);
            // true 是含有 含有再获取添加到list中
            if (annotation) {
                String value = declaredField.getAnnotation(ApiModelProperty.class).value();
                list.add(value);
            }
        }
    }

List<String> list = new ArrayList<>();：我们创建一个列表，用于存储所有字段的注释信息。
Class<OrderCsv> orderDtoClass = OrderCsv.class;：我们获取 OrderCsv 类的 Class 对象，这样就可以使用反射来获取类的元信息。
Field[] declaredFields = orderDtoClass.getDeclaredFields();：这行代码获取 OrderCsv 类中声明的所有字段，包括 private、protected 和默认访问级别的字段，但不包括父类的字段。
for (Field declaredField : declaredFields)：遍历获取到的所有字段。
declaredField.isAnnotationPresent(ApiModelProperty.class)：检查当前字段是否有 @ApiModelProperty 注解。
declaredField.getAnnotation(ApiModelProperty.class).value()：如果有注解，则获取注解的 value 属性，该属性包含字段的描述。
list.add(value);：将获取到的描述添加到列表中。