•  

编写jfinal插件实现实体,数据库自动映射

2017-12-09

    jfinal映射实体需要手动编写,并且每次添加了表后需要手动添加映射,比较繁琐。好在jfinal提供了非常牛B的插件机制,这里编写一个自动化映射插件。

1、编写注解类

package com.sl.basic.jfinal.annotaion;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * model绑定数据库表注解 name:映射的表明 pk:主键名称 maping:是否映射,默认是(true)
 * 
 * @author jiangfl 2012-9-4 上午11:48:26
 */
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target( { ElementType.TYPE })
public @interface SLEntity {
	/** 数据库表名 */
	String name() default "";

	/** 主键名,如果是联合主键,使用逗号分隔,如 cd,tm */
	String pk() default "id";

	/** 是否映射,默认映射 */
	boolean maping() default true;
	
	/** 服务名称(唯一),可以通过名称来动态获取实例,实现IOC*/
	String service() default "";
}


2、编写class扫描器,它的主要作用是从classes和jar包中(这个比较牛逼)装载class

package com.sl.basic.pkgscan;

import java.io.File;
import java.io.FileFilter;
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;

/**
 * @Description: 可装载jar和classes里面的文件
 * @Copyright: Copyright 2014 ShenZhen SL Corporation
 * @Author :jiangfl
 * @Date: 2016-7-28
 * @Version 1.0
 */
public class SLClassScan {

    public static void main(String[] args) {
        SLClassScan scan = new SLClassScan();
        System.out.println(scan.getClasses("com.sl").size());
    }

    /**
     * 从包package中获取所有的Class
     *
     * @param pack
     * @return
     */
    public 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();
                try {
                    // 如果是以文件的形式保存在服务器上
                    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;

                        // 获取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 (Throwable e) {
                                            System.err.println("SLClassScan扫描-加载类出错:" + (packageName + '.' + className) + "\n" + e.getMessage());
                                        }
                                    }
                                }
                            }
                        }

                    }
                } catch (Throwable e) {
                    System.err.println("SLClassScan扫描-加载类出错:" + e.getMessage());
                }
            }
        } catch (Throwable e) {
            System.err.println("SLClassScan扫描-加载类出错:" + e.getMessage());
        }

        return classes;
    }

    /**
     * 以文件的形式来获取包下的所有Class
     *
     * @param packageName
     * @param packagePath
     * @param recursive
     * @param classes
     */
    private 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) {
            // 如果是目录 则继续扫描
            try {
                if (file.isDirectory()) {
                    findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, classes);
                } else {
                    // 如果是java类文件 去掉后面的.class 只留下类名
                    String className = file.getName().substring(0, file.getName().length() - 6);

                    // 添加到集合中去
                    // classes.add(Class.forName(packageName + '.' +
                    // className));
                    // 经过回复同学的提醒,这里用forName有一些不好,会触发static方法,没有使用classLoader的load干净
                    if (className.indexOf("$") != -1) {//忽略静态类
                        continue;
                    }
                    String fullClass = null;
                    if (packageName.startsWith(".")) {
                        fullClass = packageName.substring(1, packageName.length()) + "." + className;
                    } else {
                        fullClass = packageName + "." + className;
                    }

                    Class<?> cls = Thread.currentThread().getContextClassLoader().loadClass(fullClass);
                    classes.add(cls);

                }
            } catch (Throwable e) {
                System.err.println("SLClassScan扫描-加载类出错:" + e.getMessage());
            }
        }
    }


}


3、编写jfinal插件

package com.sl.basic.jfinal.plugin;

import java.util.Iterator;
import java.util.Set;

import javax.sql.DataSource;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.log4j.Logger;

import com.jfinal.kit.StrKit;
import com.jfinal.plugin.activerecord.ActiveRecordPlugin;
import com.jfinal.plugin.activerecord.Config;
import com.jfinal.plugin.activerecord.IDataSourceProvider;
import com.jfinal.plugin.activerecord.Model;
import com.sl.basic.jfinal.annotaion.SLEntity;
import com.sl.basic.pkgscan.SLClassScan;

/*******************************************************************************
 * 自动绑定model与数据库表
 * 
 * @author jiangfl
 */
public class SLAutoTableBindPlugin extends ActiveRecordPlugin {
	private Logger log = Logger.getLogger(this.getClass());
	private SLTableNameStyle tableNameStyle = SLTableNameStyle.LOWER;

	private String packagePath = "";
	/**
	 * 
	 */
	private Object ignore[];

	/**
	 * 数据源
	 * 
	 * @param dataSource
	 */
	public SLAutoTableBindPlugin(DataSource dataSource) {
		super(dataSource);
	}

	/**
	 * 
	 * @param dataSourceProvider
	 *            连接池
	 * @param tableNameStyle
	 *            大小写格式
	 */
	public SLAutoTableBindPlugin(IDataSourceProvider dataSourceProvider, SLTableNameStyle tableNameStyle) {
		super(dataSourceProvider);
		this.tableNameStyle = tableNameStyle;
	}

	/**
	 * @datasourceName 数据源名称
	 * @param dataSourceProvider
	 *            数据源
	 * @param tableNameStyle
	 *            数据风格,SLTableNameStyle的值
	 * @param packagePath
	 *            要扫描的路径
	 * @param ignoreEntity
	 *            忽略的实体
	 */
	public SLAutoTableBindPlugin(String datasourceName, IDataSourceProvider dataSourceProvider, SLTableNameStyle tableNameStyle, String packagePath,
			Object... ignore) {
		super(datasourceName, dataSourceProvider);
		this.tableNameStyle = tableNameStyle;
		this.packagePath = packagePath;
		this.ignore = ignore;
	}

	/**
	 * 
	 * @param cfg
	 *            数据连接配置对象
	 * @param tableNameStyle
	 * @param packagePath
	 * @param ignoreEntity
	 */
	public SLAutoTableBindPlugin(Config cfg, SLTableNameStyle tableNameStyle, String packagePath, Object... ignore) {
		super(cfg);
		this.setDataSource(cfg.getDataSource());
		this.tableNameStyle = tableNameStyle;
		this.packagePath = packagePath;
		this.ignore = ignore;
	}

	/**
	 * 判断cls是否是pcls的子类
	 * 
	 * @param cls
	 * @param pcls
	 * @return
	 * @author jiangfl
	 * @2014-3-30
	 */
	private boolean ischild(Class<?> cls, Class<?> pcls) {
		if (cls == null || cls == Object.class) {
			return false;
		}
		Class<?> p = cls.getSuperclass();
		if (p == pcls) {
			return true;
		} else if (p != null) {
			return ischild(p, pcls);
		}
		return false;
	}

	@SuppressWarnings({ "unchecked", "rawtypes", "unused" })
	@Override
	public boolean start() {

		// new SLActivitiConfig();

		String name = null;
		String service;
		// List<Class> modelClasses = new
		// SLClassSearcher(packagePath).findClasses(Model.class);

		// List<String> modelClasses = new
		// SLClasspathPackageScanner(packagePath).getFullyQualifiedClassNameList();
		Set<Class<?>> classes = new SLClassScan().getClasses(packagePath);
		SLEntity tb = null;
		Class modelClass = null;
		Iterator<Class<?>> iter = classes.iterator();

		while (iter.hasNext()) {

			try {
				// modelClass = Class.forName(clsStr);
				modelClass = iter.next();
				if (!ischild(modelClass, Model.class)) {
					continue;
				}

				if (contains(modelClass)) {
					continue;
				}
				tb = (SLEntity) modelClass.getAnnotation(SLEntity.class);

				if (tb.maping() == false) {
					continue;
				}

				if (tb == null) {
					name = tableName(modelClass);
					this.addMapping(name, modelClass);
					System.out.println("Model added: " + name);
				} else {
					if (tb.maping()) {
						name = StrKit.notBlank(tb.name()) ? tb.name() : modelClass.getSimpleName();
						this.addMapping(name, tb.pk(), modelClass);
						System.out.println("Model added: " + modelClass.getSimpleName());
					}
				}

				/*
				 * // 获取注解服务
				 * if (tb.service() == null || "".equals(tb.service())) {
				 * service = modelClass.getSimpleName();
				 * } else {
				 * service = tb.service();
				 * }
				 * //实例化一个对象放到容器中
				 * SLBeanContainerPlugin.newInstance(service, modelClass);
				 */
			} catch (Exception e) {
				e.printStackTrace();
				System.out.println("实体映射出错:" + name + "  > " + modelClass);
				throw new RuntimeException(e);
			}
		}

		return super.start();
	}

	@Override
	public boolean stop() {
		return super.stop();
	}

	private boolean contains(Class<?> clazz) {
		if (ignore == null && ignore.length == 0) {
			return false;
		}
		for (Object item : ignore) {
			if (item instanceof String) {
				if (clazz.getName().startsWith((String) item)) {
					return true;
				}
			} else if (item instanceof Class<?>) {
				if (((Class<?>) item).equals(clazz)) {
					return true;
				}
			}
		}
		return false;
	}

	private String tableName(Class<?> clazz) {
		String tableName = clazz.getSimpleName();
		if (tableNameStyle == SLTableNameStyle.UP) {
			tableName = tableName.toUpperCase();
		} else if (tableNameStyle == SLTableNameStyle.LOWER) {
			tableName = tableName.toLowerCase();
		} else {
			tableName = StrKit.firstCharToLowerCase(tableName);
		}
		return tableName;
	}
}


4、大小写枚举类

package com.sl.basic.jfinal.plugin;

public enum SLTableNameStyle {
	UP, LOWER, UP_UNDERLINE, LOWER_UNDERLINE
}


5、具体使用方式

	/**
	 * 配置插件 3
	 */
	public void configPlugin(Plugins me) {


// ########系统管理数据库
		Properties p = null;//自己从配置文件中获取,或者下面的属性写死
		// 数据库连接池插件
		C3p0Plugin dbPoolPlugin = new C3p0Plugin(p.getProperty("jdbc.url"), p.getProperty("jdbc.username"),
				p.getProperty("jdbc.password"), p.getProperty("jdbc.driverClassName"), Integer.valueOf(p
						.getProperty("jdbc.maxPoolSize")), Integer.valueOf(p.getProperty("jdbc.minPoolSize")),
				Integer.valueOf(p.getProperty("jdbc.initialPoolSize")), Integer.valueOf(p
						.getProperty("jdbc.maxIdleTime")), Integer.valueOf(p.getProperty("jdbc.acquireIncrement")));
		me.add(dbPoolPlugin);


		// 自动进行表映射(核心)
		SLAutoTableBindPlugin tablePlugin = new SLAutoTableBindPlugin("mysql", dbPoolPlugin,
				SLTableNameStyle.LOWER, "com.sl");

	       // tablePlugin.setDialect();

		//tablePlugin.setContainerFactory()查询结果全部小写
		// 设置事务级别
		//tablePlugin.setTransactionLevel(0);
		tablePlugin.setShowSql(true);
		me.add(tablePlugin);

	}

好了,如果缺少什么,请大家给我留言。

申明:本文受法律保护,未经作者同意不得用于商业用途,如转载请说明出处!
评论