一款小巧、灵活的ORM框架——Sorm

该项目源码地址:https://github.com/ggb2312/sorm
配套demo项目:https://github.com/ggb2312/sorm/tree/master/sormdemo
jar包地址:https://github.com/ggb2312/sorm/tree/master/jar

更新日志

v0.1
    1.完成基本功能
v0.2
    1.修改query接口(模板方法executeQueryTemplate)
    2.新增queryFactory统一管理query对象(原型模式)
    3.新增连接池
v0.3
    1.已存在的po不生成

1. 框架简介

S意味着super、smart、simple,orm即Object Relational Mapping。
Sorm是一款可以实现对象和SQL自动映射的Java框架 。

核心功能:

根据表生成实体类

根据实体类生成对应sql语句

2. 依赖

将jar包引入即可

3. 快速使用

  1. 在src下建立db.properties
  2. 每张表只能有一个主键。不能处理多个主键的情况。
  3. po尽量使用包装类,不要使用基本数据类型。

下面介绍一些使用示例

3.1 环境准备

(1)创建表

CREATE TABLE `dept` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `dname` varchar(255) DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

insert  into `dept`(`id`,`dname`,`address`) values (1,'财务部','金融街'),(2,'技术部','四三旗');

CREATE TABLE `emp` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `empname` varchar(255) DEFAULT NULL,
  `salary` double DEFAULT NULL,
  `birthday` date DEFAULT NULL,
  `age` int(11) DEFAULT NULL,
  `deptId` int(11) DEFAULT NULL,
  `bonus` double DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=9 DEFAULT CHARSET=utf8;

insert  into `emp`(`id`,`empname`,`salary`,`birthday`,`age`,`deptId`,`bonus`) values (2,'tom',2500.4,'2019-04-01',25,1,200),(3,'kangkang',3000.8,'2019-04-01',30,2,100),(4,'mali',3000.8,'2019-04-01',30,1,300),(5,'lily',3000.8,'2019-04-01',30,1,121),(6,'lily',3000.8,'2019-04-01',30,1,123),(7,'lily',3000.8,'2019-04-01',30,2,123),(8,'lily',3000.8,'2019-04-01',30,2,123);

(2)创建db.properties文件

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/sorm
user=root
pwd=root
# 使用的数据库名
usingDB=mysql
# src路径  需要修改
srcPath=D:\\code\\GitRepository\\SORM\\sormdemo\\src
# sorm生成pojo的路径  需要修改
poPackage=cn.sormdemo.po
# QueryFactory的实现 
queryClass=cn.lastwhisper.sorm.core.MySqlQuery
# 连接池参数
poolMinSize=5
poolMaxSize=100

(3)生成对应实体类

import cn.lastwhisper.sorm.core.TableContext;

public class Generate {
    public static void main(String[] args) throws ClassNotFoundException {
        // 初始化po
        TableContext.updateJavaPOFile();
    }
}

3.1 增加

将对象对应成sql语句,执行sql,插入数据库中

@Test
public void addTest() {
    // 增
    Emp e = new Emp();
    e.setEmpname("lily");
    e.setBirthday(new java.sql.Date(System.currentTimeMillis()));
    e.setAge(30);
    e.setSalary(3000.8);
    QueryFactory.createQuery().insert(e);
}

3.2 删除

根据对象主键的值,生成sql,执行,从库中删除

@Test
public void deleteTest() {
    // 删
    Emp e = new Emp();
    e.setId(9);
    QueryFactory.createQuery().delete(e);
}

3.3 修改

根据对象需要修改属性的值,生成sql,执行

@Test
public void updateTest() {
    // 改
    Emp e = new Emp();
    e.setId(5);
    e.setEmpname("tom");
    e.setAge(25);
    e.setSalary(2500.4);
    QueryFactory.createQuery().update(e, new String[] { "empname", "age", "salary" });
}

3.4 查询

3.4.1 多行多列

(1)pojo查询

@Test
public void queryPojoTest() {
    // pojo查
    List<Emp> pojo = QueryFactory.createQuery().queryRows(
                "select id,empname,salary,birthday,age,deptId,bonus from emp where empname=?", Emp.class, new String[] { "tom" });
    for (Emp e : pojo) {
        System.out.println("empname:" + e.getEmpname());
    }
}

(2)vo查询

package cn.sormdemo.vo;

public class EmpVO {
    
    private Integer id;
    private String empname;
    private Double totalSalary; 
    private Integer age;
    private String deptName;
    private String deptAddr;
    
    
    public EmpVO(Integer id, String empname, Double totalSalary, Integer age,
            String deptName, String deptAddr) {
        super();
        this.id = id;
        this.empname = empname;
        this.totalSalary = totalSalary;
        this.age = age;
        this.deptName = deptName;
        this.deptAddr = deptAddr;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getEmpname() {
        return empname;
    }
    public void setEmpname(String empname) {
        this.empname = empname;
    }
    public Double getTotalSalary() {
        return totalSalary;
    }
    public void setTotalSalary(Double totalSalary) {
        this.totalSalary = totalSalary;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getDeptName() {
        return deptName;
    }
    public void setDeptName(String deptName) {
        this.deptName = deptName;
    }
    public String getDeptAddr() {
        return deptAddr;
    }
    public void setDeptAddr(String deptAddr) {
        this.deptAddr = deptAddr;
    }
    
    public EmpVO() {
    }

}
@Test
public void queryVoTest() {
        // vo查
    List<EmpVO> vo = QueryFactory.createQuery().queryRows(
                "select e.id,e.empname,e.salary+e.bonus 'totalSalary',age,d.dname deptName from emp e join dept d on e.deptId=d.id;", EmpVO.class, null);
    for (EmpVO empVO : vo) {
        System.out.println(empVO.getEmpname() + "-" + empVO.getTotalSalary());
    }
}

3.4.2 一行多列

@Test
public void queryUniqueRowTest() {
    // 一行多列 查询
    Emp queryUniqueRow = (Emp) QueryFactory.createQuery().queryUniqueRow(
                "select id,empname,salary,birthday,age,deptId,bonus from emp where empname=?", Emp.class, new String[] { "tom" });
    System.out.println(queryUniqueRow.getEmpname() + "-" + queryUniqueRow.getBirthday());
}

3.4.3 一行一列

(1)number

@Test
public void queryNumberTest() {
    // 数字 查询
    Number count = QueryFactory.createQuery().queryNumber("select count(*) from emp where empname=?",new String[] { "tom" });
    System.out.println(count);
}

(2)普通对象

@Test
public void queryObjectTest() {
    // 普通对象 查询
    String empname = (String) QueryFactory.createQuery().queryValue("select empname from emp where empname=?",new String[] { "tom" });
    System.out.println(empname);
}

4. 核心架构

  • Query接口:
    • 负责查询(对外提供服务的核心类)
  • QueryFactory类:
    • 负责根据配置信息创建query对象
  • TypeConvertor接口:
    • 负责类型转换
  • TableContext类:
    • 负责获取管理数据库所有表结构和类结构的关系,并可以根据表结构生成类结构。
  • DBManager类:
    • 根据配置信息,维持连接对象的管理(对接连接池功能)
  • 核心bean
    • ColumnInfo 封装表中一个字段的信息(字段类型、字段名、键类型)
    • Configuration 封装配置文件信息
    • TableInfo 封装一张表的信息
  • 工具类:
    • JDBCUtils封装常用JDBC操作
    • StringUtils封装常用字符串操作
    • JavaFileUtils封装java文件操作
    • ReflectUtils封装常用反射操作
    • PathUtils封装获取路径的操作

Sorm架构图:

Sorm架构图

5. 设计模式

  • 使用工厂模式统一管理Query的创建
  • 使用原型模式提高Query对象的创建效率

6. 待优化

  • 目前使用的是list集合维护的一个连接池,性能太差,将来会整合druid等连接池。
  • 目前不支持特殊的字段名和表名,将来会添加@TableName(表名注解)、@TableId(主键注解)、@TableField(非主键注解)等注解使实体字段名更加灵活。
  • 目前只支持单实体类、单主键,将来会添加一对多、多对多。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,924评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,781评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,813评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,264评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,273评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,383评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,800评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,482评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,673评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,497评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,545评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,240评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,802评论 3 304
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,866评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,101评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,673评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,245评论 2 341