眾所周知，ORM框架有很多，例如Hibernate，MyBatis，還有BeetlSQL等等，里面獲取有很多我們不需要的功能，本系列博客主要教大家如何寫一個(gè)簡(jiǎn)單的ORM框架

這個(gè)ORM框架主要有以下功能：

1. 生成JavaBean代碼
2. 通過JavaBean來實(shí)現(xiàn)增刪查改

我們這次先講如何生成JavaBean代碼

主要有以下幾個(gè)步驟：

1. 獲取數(shù)據(jù)庫連接
2. 獲取表的信息
3. 將數(shù)據(jù)庫的類型轉(zhuǎn)為Java類型
4. 生成代碼文件

1.獲取數(shù)據(jù)庫連接

先寫配置文件

#數(shù)據(jù)庫驅(qū)動(dòng)
driver=com.mysql.jdbc.Driver
#數(shù)據(jù)庫url
url=jdbc\:mysql\://localhost\:3306/shiro
#數(shù)據(jù)庫用戶名
user=root
#數(shù)據(jù)庫密碼
pwd=root
#使用數(shù)據(jù)庫類型
usingDB=mysql
#項(xiàng)目src地址
srcPath=/home/xjk/IdeaProjects/SORM/src
#生成JavaBean包名
poPackage=com.jk.po

我們還需要一個(gè)配置信息的管理類

public class Configuration {
    private String driver;
    private String url;
    private String user;
    private String pwd;
    private String usingDB;
    private String srcPath;
    private String poPackage;
    public Configuration() {
    }
    /**
     * 省略setter和getter
     */
}

然后需要一個(gè)數(shù)據(jù)庫管理類，來使用配置信息生成數(shù)據(jù)庫連接

private static Configuration conf;
    static {
        Properties properties=new Properties();
        try {
            properties.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("db.properties"));
        } catch (IOException e) {
            e.printStackTrace();
        }
        conf=new Configuration();
        conf.setDriver(properties.getProperty("driver"));
        conf.setPoPackage(properties.getProperty("poPackage"));
        conf.setSrcPath(properties.getProperty("srcPath"));
        conf.setPwd(properties.getProperty("pwd"));
        conf.setUser(properties.getProperty("user"));
        conf.setUrl(properties.getProperty("url"));
        conf.setUsingDB(properties.getProperty("usingDB"));
    }

    public static Connection getConn(){
        try {
            //要求JVM查找并加載指定的數(shù)據(jù)庫驅(qū)動(dòng)
            Class.forName(conf.getDriver());
            return DriverManager.getConnection(conf.getUrl(),conf.getUser(),conf.getPwd());
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return null;
    }

    public static Configuration getConf(){
        return conf;
    }
}

2.獲取表的信息

我們使用TableContext來裝載所有表，使用TableInfo來裝載每個(gè)表的信息，ColumnInfo來裝載每個(gè)字段的信息，我們先從最小單位開始
ColumnInfo

public  class ColumnInfo {
    /**
     * 字段名
     */
    String name;
    /**
     * 字段的數(shù)據(jù)類型
     */
    String dataType;
    /**
     * 字段的鍵類型（0：普通鍵，1：主鍵，2：外鍵）
     */
    int keyType;

    public ColumnInfo() {
    }
    /**
     * 省略setter和getter
     */
}

TableInfo

public class TableInfo {
    /**
     * 表名
     */
    private String tname;

    /**
     * 所有字段信息
     */
    private Map<String,ColumnInfo> columns;

    /**
     * 唯一主鍵（目前我們只能處理表中只有一個(gè)主鍵的情況）
     */
    private ColumnInfo onlyPriKey;

    /**
     * 聯(lián)合主鍵
     */
    private List<ColumnInfo> priKeys;
    
    public TableInfo() {
    }
    /**
     * 省略setter和getter
     * /
}

TableContext

public class TableContext {
    /**
     * 表名為key，表結(jié)構(gòu)為value
     */
    public static Map<String,TableInfo> tables=new HashMap<>();

    private TableContext(){}

    static {
        try {
            Connection con=DBManager.getConn();
            DatabaseMetaData dbmd=con.getMetaData();
            //獲取所有表名
            ResultSet tableRet=dbmd.getTables(null,"%","%",new String[]{"TABLE"});
            while (tableRet.next()){
                String tableName= (String) tableRet.getObject("TABLE_NAME");
                TableInfo ti=new TableInfo(tableName,new HashMap<String,ColumnInfo>(),new ArrayList<ColumnInfo>());
                tables.put(tableName,ti);
                //獲取多個(gè)字段和類型
                ResultSet set=dbmd.getColumns(null,"%",tableName,"%");
                while (set.next()){
                    ColumnInfo ci=new ColumnInfo(set.getString("COLUMN_NAME"),set.getString("TYPE_NAME"),0);
                    ti.getColumns().put(set.getString("COLUMN_NAME"),ci);
                }
                //獲取多個(gè)主鍵
                ResultSet set2=dbmd.getPrimaryKeys(null,"%",tableName);
                while (set2.next()){
                    String columnName=set2.getString("COLUMN_NAME");
                    System.out.println(columnName);
                    ColumnInfo ci2=ti.getColumns().get(columnName);
                    ci2.setKeyType(1);//設(shè)為主鍵
                    ti.getPriKeys().add(ci2);
                }
                if (ti.getPriKeys().size()>0){//取唯一主鍵，如果是聯(lián)合主鍵，則為空
                    ti.setOnlyPriKey(ti.getPriKeys().get(0));
                }
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }

    }
}

3.將數(shù)據(jù)庫的類型轉(zhuǎn)為Java類型

為了適配多種數(shù)據(jù)庫，我們先定義一個(gè)類型轉(zhuǎn)換器的接口

public interface TypeConvertor {
    /**
     * 將數(shù)據(jù)庫類型轉(zhuǎn)換為java數(shù)據(jù)類型
     * @param column 數(shù)據(jù)庫字段的類型
     * @return java的數(shù)據(jù)類型
     */
    public String databaseType2JavaType(String column);

    /**
     * 將java數(shù)據(jù)類型轉(zhuǎn)換為數(shù)據(jù)庫類型
     * @param column java的數(shù)據(jù)類型
     * @return 數(shù)據(jù)庫字段的類型
     */
    public String javaType2DatabaseType(String column);
}

我們這里只展示MySQL類型轉(zhuǎn)換器的寫法

public class MySQLTypeConvertor implements TypeConvertor{
    @Override
    public String databaseType2JavaType(String column) {
        switch (column.toLowerCase()){
            case "varchar":
            case "char":return "String";
            case "smallint":
            case "int":
            case "tinyint":return "Integer";
            case "bigint":return "Long";
            case "double":return "Double";
            case "float":return "Double";
            case "clob":return "java.sql.Clob";
            case "blob":return "java.sql.Blob";
            case "date":return "java.sql.Date";
            case "time":return "java.sql.Time";
            case "timestamp":return "java.sql.Timestamp";
            default:return null;
        }
    }

    @Override
    public String javaType2DatabaseType(String column) {
        //這里后面再完善
        return null;
    }
}

4.生成代碼文件

我們需要用一個(gè)JavaFieldGetSet來裝載MySQL每個(gè)字段對(duì)應(yīng)的屬性還有setter和getter

public class JavaFieldGetSet {
    /**
     * 屬性源碼信息，如：private int id;
     */
    private String fieldInfo;
    /**
     * get方法的源碼信息，如：public int getId();
     */
    private String getInfo;
    /**
     * set方法的源碼信息，如：public void setId(int id);
     */
    private String setInfo;

    public JavaFieldGetSet() {

    }
    /**
     * 省略setter和getter
     * /
}

在轉(zhuǎn)換的時(shí)候我們還要把名字格式從下劃線分隔轉(zhuǎn)為小駝峰，我們需要一個(gè)字符安轉(zhuǎn)換工具

public class StringUtils {
    /**
     * 將下劃線轉(zhuǎn)為大駝峰
     * @param str   目標(biāo)字符串
     * @return  變?yōu)榇篑劮宓淖址?     */
    public static String underlineToBigCamel(String str){
        return underlineToSmallCamel(str.toUpperCase().substring(0,1)+str.substring(1));
    }

    /**
     * 將下劃線轉(zhuǎn)為小駝峰
     * @param str   目標(biāo)字符串
     * @return  變?yōu)樾●劮宓淖址?     */
    public static String underlineToSmallCamel(String str){
        if (str==null||"".equals(str.trim())){
            return "";
        }
        int len=str.length();
        StringBuilder sb=new StringBuilder(len);
        for (int i = 0; i < len; i++) {
            char c=str.charAt(i);
            if (c=='_'){
                if (++i<len){
                    sb.append(Character.toUpperCase(str.charAt(i)));
                }
            }else{
                sb.append(c);
            }
        }
        return sb.toString();
    }
}

代碼生成的工具

public class JavaFileUtils {
    /**
     * 根據(jù)字段信息生成java屬性信息，如：var username-->private String username;相應(yīng)的set和get方法源碼
     * @param column    字段信息
     * @param convertor 類型轉(zhuǎn)換器
     * @return  java屬性的set/get方法
     */
    public static JavaFieldGetSet createFieldGetSetSRC(ColumnInfo column, TypeConvertor convertor){
        JavaFieldGetSet jfgs=new JavaFieldGetSet();
        //將字段轉(zhuǎn)為java屬性
        String javaFiledType= convertor.databaseType2JavaType(column.getDataType());
        String colunmName=StringUtils.underlineToSmallCamel(column.getName());
        //生成字段信息
        jfgs.setFieldInfo("\tprivate "+javaFiledType+" "+colunmName+";\n");
        //生成getter
        StringBuilder getSrc=new StringBuilder();
        getSrc.append("\tpublic "+javaFiledType+" get"+StringUtils.underlineToBigCamel(column.getName())+"(){\n");
        getSrc.append("\t\treturn "+colunmName+";\n");
        getSrc.append("\t}\n");
        jfgs.setGetInfo(getSrc.toString());
        //生成setter
        StringBuilder setSrc=new StringBuilder();
        setSrc.append("\tpublic void set"+StringUtils.underlineToBigCamel(column.getName())+"("+javaFiledType+" "+colunmName+"){\n");
        setSrc.append("\t\tthis."+colunmName+"="+colunmName+";\n");
        setSrc.append("\t}\n");
        jfgs.setSetInfo(setSrc.toString());
        return jfgs;
    }

    /**
     * 根據(jù)表信息生成java源碼
     * @param tableInfo 表信息
     * @param convertor 數(shù)據(jù)類型轉(zhuǎn)換器
     * @return  java類的源代碼
     */
    public static String createJavaSrc(TableInfo tableInfo,TypeConvertor convertor){
        Map<String,ColumnInfo>columns=tableInfo.getColumns();
        List<JavaFieldGetSet> javaFields=new ArrayList<>();
        for (ColumnInfo columnInfo:columns.values()){
            JavaFieldGetSet javaFieldGetSet=createFieldGetSetSRC(columnInfo,convertor);
            javaFields.add(javaFieldGetSet);
        }
        StringBuilder src=new StringBuilder();
        //生成package語句
        src.append("package "+ DBManager.getConf().getPoPackage()+";\n");
        //生成import語句
        src.append("import java.sql.*;\n");
        src.append("import java.util.*;\n\n");
        //生成類聲明語句
        src.append("public class "+StringUtils.underlineToBigCamel(tableInfo.getTname())+"{\n");
        //生成屬性列表
        for (JavaFieldGetSet javaFieldGetSet:javaFields){
            src.append(javaFieldGetSet.getFieldInfo());
        }
        src.append("\n\n");
        //生成get方法列表
        for (JavaFieldGetSet javaFieldGetSet:javaFields){
            src.append(javaFieldGetSet.getGetInfo());
        }
        src.append("\n\n");
        //生成set方法列表
        for (JavaFieldGetSet javaFieldGetSet:javaFields){
            src.append(javaFieldGetSet.getSetInfo());
        }
        src.append("\n\n");
        //生成結(jié)束符
        src.append("}");
        return src.toString();
    }

    /**
     * 生成java文件
     * @param tableInfo 表信息
     * @param convertor 類型轉(zhuǎn)換器
     */
    public static void createJavaPoFile(TableInfo tableInfo,TypeConvertor convertor){
        //獲取源碼
        String src=createJavaSrc(tableInfo,convertor);
        String srcPath=DBManager.getConf().getSrcPath()+"/";
        //將包名轉(zhuǎn)換為文件名，然后和srcPath拼接
        String packagePath=DBManager.getConf().getPoPackage().replace(".","/");
        File f=new File(srcPath+packagePath);
        if (!f.exists()){
            f.mkdirs();
        }
        BufferedWriter bw=null;
        try {
            //將源碼寫入文件
            bw=new BufferedWriter(new FileWriter(f.getAbsoluteFile()+"/"+StringUtils.underlineToBigCamel(tableInfo.getTname())+".java"));
            bw.write(src);
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            if (bw!=null){
                try {
                    bw.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 更新表結(jié)構(gòu)
     */
    public static void updateJavaPOFile(){
        Map<String,TableInfo>tables=TableContext.tables;
        for(TableInfo tableInfo:tables.values()){
            createJavaPoFile(tableInfo,new MySQLTypeConvertor());
        }
    }
}

當(dāng)我們調(diào)用JavaFileUtils的updateJavaPOFile方法時(shí)，便會(huì)在相應(yīng)的目錄生成該數(shù)據(jù)庫里所有表對(duì)象的JavaBean