天天看點

springmvc+fastjson enum(枚舉)支援屬性get轉json

maven引用

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.41</version>
</dependency>      

springxml配置

<mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <constructor-arg value="UTF-8" />
            </bean>
            <bean
                class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
                <property name="charset" value="UTF-8" />
                <property name="supportedMediaTypes">
                    <list>
                        <value>application/json</value>
                        <value>text/html;charset=UTF-8</value>
                    </list>
                </property>
                <property name="fastJsonConfig">
                    <bean class="com.xxx.xxx.CustomerFastJsonConfig">
                        <property name="serializerFeatures">
                            <list>
                                <value>QuoteFieldNames</value>
                                <value>DisableCircularReferenceDetect</value>
                            </list>
                        </property>
                        <property name="dateFormat" value="yyyy-MM-dd HH:mm:ss" />
                    </bean>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>      

自定義配置類

public class CustomerFastJsonConfig extends com.alibaba.fastjson.support.config.FastJsonConfig{
    
    @SuppressWarnings("unchecked")
    public CustomerFastJsonConfig(){
        super();
        //擷取指定包名下所有的有JsonFormat注解的類,因為這樣可以相容jackson的enum轉換
        //然後在springmvc轉json時,就會把标記有JsonFormat注解的枚舉中的get方法轉為json格式,當然也可以自定義一個注解
        Set<Class<?>> classes = ClassUtil.getClasses("com.xxx.cores.enums", true,JsonFormat.class);
        SerializeConfig serializeConfig = getSerializeConfig();
        for (Class<?> clazz : classes) {
            Class<? extends Enum<?>> eclazz=(Class<? extends Enum<?>>)clazz;
            serializeConfig.configEnumAsJavaBean(eclazz);
        }
    }
    
    
}      

ClassUtil

package com.xxx.xxx.utils;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

import org.apache.commons.lang3.ClassUtils;

import com.fasterxml.jackson.annotation.JsonFormat;

public class ClassUtil extends ClassUtils{

    /**
     * 是否有注解
     *
     * @param clazz
     *            a {@link java.lang.Class} object.
     * @param annotationClass
     *            a {@link java.lang.Class} object.
     * @return a boolean.
     */
    public static boolean hasClassAnnotation(Class<?> clazz, Class<? extends Annotation> annotationClass) {
        return getClassAnnotation(clazz, annotationClass) != null;
    }
    
    /**
     * 擷取類注解
     *
     * @param clazz
     *            類
     * @param annotationClass
     *            注解類
     * @return a A object.
     */
    public static <A extends Annotation> A getClassAnnotation(Class<?> clazz, Class<A> annotationClass) {
        return clazz.getAnnotation(annotationClass);
    }
    
    /**
     * 從包package中擷取所有的Class
     *
     * @param pagekageName
     *            包名
     * @param recursive
     *            是否遞歸
     * @param annotationClass 不為null時,取存在注解的類
     * @return a {@link java.util.Set} object.
     */
    public static Set<Class<?>> getClasses(String pagekageName, boolean recursive, Class<? extends Annotation> annotationClass) {
        // 第一個class類的集合
        Set<Class<?>> classes = new LinkedHashSet<Class<?>>();
        // 擷取包的名字 并進行替換
        String packageName = pagekageName;
        String packageDirName = packageName.replace('.', '/');
        // 定義一個枚舉的集合 并進行循環來處理這個目錄下的things
        Enumeration<URL> dirs;
        try {
            dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
            // 循環疊代下去
            while (dirs.hasMoreElements()) {
                // 擷取下一個元素
                URL url = dirs.nextElement();
                // 得到協定的名稱
                String protocol = url.getProtocol();
                // 如果是以檔案的形式儲存在伺服器上
                if ("file".equals(protocol)) {
                    // 擷取包的實體路徑
                    String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
                    // 以檔案的方式掃描整個包下的檔案 并添加到集合中
                    findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes,annotationClass);
                } else if ("jar".equals(protocol)) {
                    // 如果是jar封包件
                    // 定義一個JarFile
                    JarFile jar;
                    try {
                        // 擷取jar
                        jar = ((JarURLConnection) url.openConnection()).getJarFile();
                        // 從此jar包 得到一個枚舉類
                        Enumeration<JarEntry> entries = jar.entries();
                        // 同樣的進行循環疊代
                        while (entries.hasMoreElements()) {
                            // 擷取jar裡的一個實體 可以是目錄 和一些jar包裡的其他檔案 如META-INF等檔案
                            JarEntry entry = entries.nextElement();
                            String name = entry.getName();
                            // 如果是以/開頭的
                            if (name.charAt(0) == '/') {
                                // 擷取後面的字元串
                                name = name.substring(1);
                            }
                            // 如果前半部分和定義的包名相同
                            if (name.startsWith(packageDirName)) {
                                int idx = name.lastIndexOf('/');
                                // 如果以"/"結尾 是一個包
                                if (idx != -1) {
                                    // 擷取包名 把"/"替換成"."
                                    packageName = name.substring(0, idx)
                                            .replace('/', '.');
                                }
                                // 如果可以疊代下去 并且是一個包
                                if ((idx != -1) || recursive) {
                                    // 如果是一個.class檔案 而且不是目錄
                                    if (name.endsWith(".class") && !entry.isDirectory()) {
                                        // 去掉後面的".class" 擷取真正的類名
                                        String className = name.substring(packageName.length() + 1, name.length() - 6);
                                        try {
                                            // 添加到classes
                                            Class<?> forName = Class.forName(packageName + '.' + className);
                                            if(annotationClass!=null) {
                                                if(forName.getAnnotation(annotationClass)!=null) {
                                                    classes.add(forName);
                                                }
                                            }else {
                                                classes.add(forName);
                                            }
                                        } catch (ClassNotFoundException e) {
                                            e.printStackTrace();
                                            // log
                                            // .error("添加使用者自定義視圖類錯誤 找不到此類的.class檔案");
                                        }
                                    }
                                }
                            }
                        }
                    } catch (IOException e) {
                        // log.error("在掃描使用者定義視圖時從jar包擷取檔案出錯");
                        throw new RuntimeException(e);
                    }
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return classes;
    }
    
    /**
     * 以檔案的形式來擷取包下的所有Class
     *
     * @param packageName
     *            a {@link java.lang.String} object.
     * @param packagePath
     *            a {@link java.lang.String} object.
     * @param recursive
     *            a boolean.
     * @param classes
     *            a {@link java.util.Set} object.
     */
    public static void findAndAddClassesInPackageByFile(String packageName,
            String packagePath, final boolean recursive, Set<Class<?>> classes, Class<? extends Annotation> annotationClass) {
        // 擷取此包的目錄 建立一個File
        File dir = new File(packagePath);
        // 如果不存在或者 也不是目錄就直接傳回
        if (!dir.exists() || !dir.isDirectory()) {
            // log.warn("使用者定義包名 " + packageName + " 下沒有任何檔案");
            return;
        }
        // 如果存在 就擷取包下的所有檔案 包括目錄
        File[] dirfiles = dir.listFiles(new FileFilter() {
            // 自定義過濾規則 如果可以循環(包含子目錄) 或則是以.class結尾的檔案(編譯好的java類檔案)
            public boolean accept(File file) {
                return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
            }
        });
        // 循環所有檔案
        for (File file : dirfiles) {
            // 如果是目錄 則繼續掃描
            if (file.isDirectory()) {
                findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, classes,annotationClass);
            } else {
                // 如果是java類檔案 去掉後面的.class 隻留下類名
                String className = file.getName().substring(0, file.getName().length() - 6);
                try {
                    // 添加到集合中去
                    Class<?> forName = Class.forName(packageName + '.' + className);
                    if(annotationClass!=null) {
                        if(forName.getAnnotation(annotationClass)!=null) {
                            classes.add(forName);
                        }
                    }else {
                        classes.add(forName);
                    }
                } catch (ClassNotFoundException e) {
                    // log.error("添加使用者自定義視圖類錯誤 找不到此類的.class檔案");
                    e.printStackTrace();
                }
            }
        }
    }
    
    
    public static void main(String[] args) {
        Set<Class<?>> classes = getClasses("com.xxx.cores.enums", true,JsonFormat.class);
        System.out.println(classes.size());
        for (Class<?> class1 : classes) {
            System.out.println(class1.getName());
        }
    }
}      

枚舉定義

package com.xxx.xxx.enums.community;/**
 * 
* @Description:檔案類型
* @author:xxx
* @date:2017年7月8日 上午11:57:37
 */
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum FileType {
    VIDEO("視訊"),
    IMAGE("圖檔")
    ;
    private FileType(String displayName) {
        this.displayName = displayName;
    }

    private String displayName;

    public String getDisplayName() {
        return displayName;
    }
    
    public String getCode(){
        return this.name();
    }

    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }
}      

輸出結果

//FileType.IMAGE
{"code":"IMAGE","displayName":"圖檔"}