快捷導(dǎo)航

Java如何獲取屬性的注釋信息詳解

更新時(shí)間：2021年07月14日 14:16:39 作者：鬧了個(gè)笑話吧

Java注解是從Java5開(kāi)始添加到Java的,這篇文章主要給大家介紹了關(guān)于Java如何獲取屬性的注釋信息的相關(guān)資料,文中介紹的非常詳細(xì),需要的朋友可以參考下

前言

注解是JavaSE5.0開(kāi)始提供的一項(xiàng)新特性，利用此特性可以通過(guò)特定的注解標(biāo)簽為程序提供一些描述性信息。這些描述性信息可以在編譯或運(yùn)行時(shí)為編譯器、運(yùn)行環(huán)境提供附加的信息，從而簡(jiǎn)化開(kāi)發(fā)。本文將詳細(xì)介紹Java獲取屬性注釋信息的相關(guān)內(nèi)容，下面來(lái)一起看看詳細(xì)的實(shí)現(xiàn)代碼

實(shí)例代碼

1.數(shù)據(jù)模型

package com.example.demo;

import java.util.List;

/**
 * Description:
 *
 * @author jack
 * @date 2021/7/13 5:15 下午
 */
public class DocVO {

    private List<FieldVO> fieldVOList;

    public DocVO(List<FieldVO> fieldVOList) {
        this.fieldVOList = fieldVOList;
    }

    public static class FieldVO {
        /**
         * 屬性名稱(chēng)
         */
        private String fieldName;

        /**
         * 屬性類(lèi)型
         */
        private String fieldType;

        /**
         * 屬性注釋
         */
        private String describe;

        public FieldVO() {
        }

        public FieldVO(String fieldName, String fieldType, String describe) {
            this.fieldName = fieldName;
            this.fieldType = fieldType;
            this.describe = describe;
        }

        public String getFieldName() {
            return fieldName;
        }

        public void setFieldName(String fieldName) {
            this.fieldName = fieldName;
        }

        public String getFieldType() {
            return fieldType;
        }

        public void setFieldType(String fieldType) {
            this.fieldType = fieldType;
        }

        public String getDescribe() {
            return describe;
        }

        public void setDescribe(String describe) {
            this.describe = describe;
        }

        @Override
        public String toString() {
            return "FieldVO{" +
                    "fieldName='" + fieldName + '\'' +
                    ", fieldType='" + fieldType + '\'' +
                    ", describe='" + describe + '\'' +
                    '}';
        }
    }

    public List<FieldVO> getFieldVOList() {
        return fieldVOList;
    }

    public void setFieldVOList(List<FieldVO> fieldVOList) {
        this.fieldVOList = fieldVOList;
    }
}

2.工具類(lèi)

package com.example.demo;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.FieldDoc;
import com.sun.javadoc.RootDoc;
import com.sun.tools.javadoc.Main;

import java.util.ArrayList;
import java.util.List;

/**
 * Description:
 *
 * @author jack
 * @date 2021/7/13 5:10 下午
 */
public class DocUtil {

    /**
     * 會(huì)自動(dòng)注入
     */
    private static RootDoc rootDoc;

    /**
     * 會(huì)自動(dòng)調(diào)用這個(gè)方法
     *
     * @param root root
     * @return true
     */
    public static boolean start(RootDoc root) {
        rootDoc = root;
        return true;
    }

    /**
     * 生成文檔
     *
     * @param beanFilePath 注意這里是.java文件絕對(duì)路徑
     * @return 文檔注釋
     */
    public static DocVO execute(String beanFilePath) {
        Main.execute(new String[]{"-doclet", DocUtil.class.getName(), "-docletpath",
                DocUtil.class.getResource("/").getPath(), "-encoding", "utf-8", beanFilePath});

        ClassDoc[] classes = rootDoc.classes();

        if (classes == null || classes.length == 0) {
            return null;
        }
        ClassDoc classDoc = classes[0];
        // 獲取屬性名稱(chēng)和注釋
        FieldDoc[] fields = classDoc.fields(false);

        List<DocVO.FieldVO> fieldVOList = new ArrayList<>(fields.length);

        for (FieldDoc field : fields) {
            fieldVOList.add(new DocVO.FieldVO(field.name(), field.type().typeName(), field.commentText()));
        }
        return new DocVO(fieldVOList);
    }

}

3.測(cè)試

package com.example.demo;

import java.util.Objects;

/**
 * Description:
 *
 * @author jack
 * @date 2021/7/13 4:11 下午
 */
public class ClassTest {
    public static void main(String[] args) {
        String beanFilePath = "/Documents/demo/src/main/java/com/example/demo/dto/MailDTO.java";
        DocVO docVO = DocUtil.execute(beanFilePath);
        if (Objects.nonNull(docVO) && Objects.nonNull(docVO.getFieldVOList())){
            docVO.getFieldVOList().forEach(System.out::println);
        }
    }
}