SpringBoot+MyBatis中自動根據@Table註解和@Column註解生成ResultMap
阿新 • • 發佈：2018-12-03
while ash 標記 ast protoc 第一個 ann element conf
其實我一點都不想用mybatis，好多地方得自己寫，比如這裏。
使用mybatis要寫大量的xml，煩的一批。最煩人的莫過於寫各種resultmap，就是數據庫字段和實體屬性做映射。我認為這裏應該是mybatis自動支持的，但是，它沒有。為了輕量化（caocaocoa）？？？。
很少用mybatis，不知道有沒有相關插件。只有自己寫方法實現了。
先整理一下大體思路：
1.掃描項目代碼下的所有類
2.選出所有類中的含有Table註解的類
3.根據column註解找出類下的屬性映射關系
4.創建mybatis配置類，在mybatis配置完成後根據2.3兩步的信息創建新的resultmap添加到mybatis的SqlSessionFactory中
代碼：
這個是mybatis配置類，
import java.util.ArrayList; import java.util.Collection; import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Set; import javax.persistence.Table; import org.apache.ibatis.binding.MapperRegistry; import org.apache.ibatis.mapping.ResultMap;import org.apache.ibatis.mapping.ResultMapping; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.log4j.Logger; import org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.AutoConfigureAfter;import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Configuration; import com.esri.rest.util.ClassUtil; import com.esri.rest.util.SpringUtil; @Configuration @AutoConfigureAfter(MybatisAutoConfiguration.class) public class MyBatisTypeMapScannerConfig { private Logger log = Logger.getLogger(MyBatisTypeMapScannerConfig.class); public MyBatisTypeMapScannerConfig(ApplicationContext applicationContext, SqlSessionFactory sqlSessionFactory) { log.debug("自動添加resultMap"); org.apache.ibatis.session.Configuration configuration = sqlSessionFactory.getConfiguration(); //ResultMap rm = new ResultMap.Builder(configuration, id, type, null).build(); //configuration.addResultMap(rm); // 選出所有類中的含有Table註解的類 List<Class<?>> list = ClassUtil.getClassesWithAnnotation(Table.class); for (Class<?> clas : list) { System.out.println(clas);
//創建新的resultmap添加到mybatis的SqlSessionFactory中 ResultMap rm = new ResultMap.Builder(configuration, clas.getName(), clas, getResultMapping(configuration, clas)).build(); configuration.addResultMap(rm); } log.debug("自動添加resultMap"); } private List<ResultMapping> getResultMapping(org.apache.ibatis.session.Configuration configuration, Class<?> type) { List<ResultMapping> resultMappings = new ArrayList<ResultMapping>();
// 根據column註解找出類下的屬性映射關系 Map<String, Map<String, Object>> cols = ClassUtil.getColumnRelation(type); System.out.println(cols); Set<String> keys = cols.keySet(); String[] keyArr = new String[keys.size()]; keys.toArray(keyArr); for(String key:keyArr){ String property; String column; Object javaType; Map<String, Object> map = cols.get(key); property = key; column = (String) map.get("dbname"); javaType = map.get("type"); ResultMapping mapping = new ResultMapping.Builder(configuration, property, column,(Class<?> )javaType).build(); resultMappings.add(mapping); } return resultMappings; } }
ClassUtil 類
import java.io.File; import java.io.FileFilter; import java.io.IOException; import java.lang.annotation.Annotation; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.net.JarURLConnection; import java.net.URL; import java.net.URLDecoder; import java.util.ArrayList; import java.util.Enumeration; import java.util.HashMap; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.jar.JarEntry; import java.util.jar.JarFile; import javax.persistence.Column; import javax.persistence.Table; /** * 掃描esri包下的所有類 * <p> * Title: ClassUtil.java * </p> * <p> * Description: * </p> * * @author lichao1 * @date 2018年12月3日 * @version 1.0 */ public class ClassUtil { private static Set<Class<?>> classList; static { classList = getClasses("com.esri.rest"); } /** * 從包package中獲取所有的Class * * @param pack * @return */ public static Set<Class<?>> getClasses(String pack) { // 第一個class類的集合 Set<Class<?>> classes = new LinkedHashSet<Class<?>>(); // 是否循環叠代 boolean recursive = true; // 獲取包的名字 並進行替換 String packageName = pack; 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)) { // System.err.println("file類型的掃描"); // 獲取包的物理路徑 String filePath = URLDecoder.decode(url.getFile(), "UTF-8"); // 以文件的方式掃描整個包下的文件 並添加到集合中 findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes); } else if ("jar".equals(protocol)) { // 如果是jar包文件 // 定義一個JarFile // System.err.println("jar類型的掃描"); 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 classes.add(Class.forName(packageName + ‘.‘ + className)); } catch (ClassNotFoundException e) { // log // .error("添加用戶自定義視圖類錯誤 // 找不到此類的.class文件"); e.printStackTrace(); } } } } } } catch (IOException e) { // log.error("在掃描用戶定義視圖時從jar包獲取文件出錯"); e.printStackTrace(); } } } } catch (IOException e) { e.printStackTrace(); } return classes; } /** * 以文件的形式來獲取包下的所有Class * * @param packageName * @param packagePath * @param recursive * @param classes */ private static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, Set<Class<?>> classes) { // 獲取此包的目錄 建立一個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); } else { // 如果是java類文件 去掉後面的.class 只留下類名 String className = file.getName().substring(0, file.getName().length() - 6); try { // 添加到集合中去 // classes.add(Class.forName(packageName + ‘.‘ + // className)); // 經過回復同學的提醒，這裏用forName有一些不好，會觸發static方法，沒有使用classLoader的load幹凈 classes.add( Thread.currentThread().getContextClassLoader().loadClass(packageName + ‘.‘ + className)); } catch (ClassNotFoundException e) { // log.error("添加用戶自定義視圖類錯誤 找不到此類的.class文件"); e.printStackTrace(); } } } } /** * 根據註解查找類 * * @param annotationType * @return */ public static List<Class<?>> getClassesWithAnnotation(Class<? extends Annotation> annotationType) { List<Class<?>> list = new ArrayList<Class<?>>(); Object[] ts = classList.toArray(); for (Object t : ts) { Class<?> ty = (Class<?>) t; Object aclass = ty.getAnnotation(annotationType); if (aclass != null) { list.add(ty); } } return list; } /** * 獲取類中標記Column註解的字段 * @param clas * @return */ public static Map<String, Map<String, Object>> getColumnRelation(Class<?> clas){ Map<String, Map<String, Object>> cols = new HashMap<String, Map<String, Object>>(); // 直接標註屬性 Field field; Field[] fields = clas.getDeclaredFields(); for (int i = 0; i < fields.length; i++) { fields[i].setAccessible(true); } for (int i = 0; i < fields.length; i++) { Map<String, Object> map= new HashMap<String, Object>(); try { field = clas.getDeclaredField(fields[i].getName()); Column column = field.getAnnotation(Column.class); if (column != null) { map.put("dbname", column.name()); map.put("length", column.length()); map.put("type", field.getType()); //System.out.println(column.name()); //System.out.println(column.length()); cols.put(field.getName(), map); } } catch (Exception e) { } } // 標註方法 Method method; Method[] methods = clas.getDeclaredMethods(); for (int i = 0; i < methods.length; i++) { Map<String, Object> map= new HashMap<String, Object>(); try { method = methods[i]; Column column = method.getAnnotation(Column.class); if (column != null) { String filedName = method.getName(); boolean isGet = filedName.indexOf("get")>=0; if(isGet){ map.put("type", method.getReturnType()); }else{ map.put("type", method.getParameterTypes()[0]); } filedName = filedName.replaceAll("set", ""); filedName = filedName.replaceAll("get", ""); filedName = filedName.substring(0, 1).toLowerCase() + filedName.substring(1); map.put("dbname", column.name()); map.put("length", column.length()); cols.put(filedName, map); } } catch (SecurityException e) { e.printStackTrace(); } } return cols; } public static void main(String[] args) { System.out.println(classList); // Object[] ts = classList.toArray(); // for(Object t:ts){ // Class<?> tt = (Class<?>) t; // System.out.println(tt); // } List<Class<?>> list = getClassesWithAnnotation(Table.class); for (Class<?> clas : list) { System.out.println(clas); Map<String, Map<String, Object>> cols = getColumnRelation(clas); System.out.println(cols); } } }
經測試可行，細節方面自己調整
SpringBoot+MyBatis中自動根據@Table註解和@Column註解生成ResultMap