1 Star 0 Fork 65

lyzhanghai / MiniJdbc

forked from 沈晓军 / mini-jdbc 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

MiniJdbc - 介绍&使用说明

sxjun @2016-01-15

使用MiniJdbc的项目:LarvaFrame(供参考)

该项目仍在持续完善中...

一、MiniJdbc介绍

**1、MiniJdbc:**针对spring jdbc的一些不方便的地方,做了一些封装,大小写不敏感,简化了日常的开发工作。 基于spring jdbc的RowMapper自动实现对象映射,大部分功能已经由spring jdbc实现了。

**2、数据类型的设计:**集成了JFinal和SBORM的优点,对字段的大小写不敏感,对强类型实体、弱类型实体和非实体的支持。

**3、统一的接口:**强类型、弱类型采用统一的数据库接口,例如:可以采用统一的insert方法报错强类型或弱类型数据。

**4、数据库的支持:**目前已经支持MySql、SqlServer、Oracle数据库,屏蔽了数据库的语法差异。

**5、强弱类型完美结合:**例如,在数据库插入一个用户:

//强类型编程
User user = new User();//新建User对象,表名和主键在实体注解中定义
user.setName("admin").setPassword("000000");//设置数据
dao.insert(user);//保存用户

//弱类型编程
Record record = new Record("user","id");//新建记录对象,构造函数传表名和主键
record.set("name", "admin").set("password", "000000");//设置数据
dao.insert(record);//保存用户

**6、大小写不敏感:**弱类型编程中,对应表、字段的大小写不敏感。

//设置name字段,可以小写
record.set("name", "admin");
//也可以大写
record.set("NAME", "admin");
//还可以随意写
record.set("NaMe", "admin");

##二、关于数据类型 MiniJdbc在设计时考虑到3种数据类型:强实体,弱实体,非实体。

强、弱实体的区别:强、弱实体都属于实体(BaseEntity),但强实体包含成员变量和正常的get/set方法,而弱实体则没有成员变量,且get/set方法与强实体也有区别。强实体继承StrongEntity类,弱实体继承WeakEntity类。

弱实体和非实体区别:非实体可以只能通过get("name")的方式获取值,而弱实体可以通过user.getName()的方式获取值。

强实体

@Entity(table="users", id = { "id" },strategy=StrategyType.UUID)
public class User extends StrongEntity implements Serializable {
	@Column("id")
	private String id;
	@Column("name")
	private String name;

	public void setId (String id) {
		this.id = id;
	}
	public String getId () {
		return this.id;
	}
	public void setName (String name) {
		this.name = name;
	}
	public String getName () {
		return this.name;
	}
}

弱实体

@Entity(table="users", id = { "id" },strategy=StrategyType.UUID)
public class User extends WeakEntity implements Serializable {
	public User setId (String id) {
		super.set("id", id);
		return this;
	}
	public String getId () {
		return super.get("id");
	}
	public User setName (String name) {
		super.set("name", name);
		return this;
	}
	public String getName () {
		return super.get("name");
	}
}

####实体注解说明#### Entity,配置对应的table和id值,以及策略,如果不配置需要在开发时手动设置;

table(String):设置数据库表名(必填);

id(String[]):设置数据库主键(必填);

strategy(StrategyType):主键的生成策略,目前支持如下策略;

StrategyType.NULL 默认需要手动设置主键值

StrategyType.AUTO 主键值自动增长

StrategyType.UUID 自动生成system.uuid作为主键

ignore_field(String[]):插入、修改都要排除的数据库字段;

ignore_insert_field(String[]):插入时要排除的数据库字段;

ignore_update_field(String[]):更新时要排除的数据库字段;

not_null_field(String[]):不许为Null的字段.

##三、MiniDao全部接口 接口中强类型和弱类型都使用统一的DAO接口; [Record.class(弱类型);BaseEntity.class(强类型基类)]

//插入数据
public <T extends Model> int insert(T record);
//删除数据
public <T extends Model> int delete(T record);
//删除数据
public int deleteById(Class<? extends BaseEntity> clazz, Object primaryKey);
//更新数据
public <T extends Model> int update(T record);
//执行sql语句
public int execute(String sql, Object... paras);
//根据ID查找单个实体
public <T> T findById(Class<? extends BaseEntity> clazz, Object primaryKey);
//查找单条记录
public <T> T find(String sql, Class clazz, Object... args);
//查找一个list
public <T> List<T> findList(String sql, Class clazz, Object... args);
//分页查找一个list
public <T> List<T> paginate(String sql,int pageNumber, int pageSize, Class clazz, Object... args);
//获取分页Record数据
public <T> PageResult<T> paginateResult(String sql, int pageNumber, int pageSize, Class clazz, Object... args);

四、使用说明

###1、配置规范 配置文件 datasource配置包括3部分:扫描包、数据源、动态数据源,和普通的spring配置一致;
(连接池使用看个人喜好):

<!-- 1.配置扫描包 -->
<context:component-scan base-package="com.mini"/>

<!-- 2.配置druid数据源 -->
<bean id="datasource" class="com.alibaba.druid.pool.DruidDataSource" >
	    <property name="driverClassName" value="${jdbc.driver}" />
	    <property name="url" value="${jdbc.database}" />
	    <property name="username" value="${jdbc.user}" />
	    <property name="password" value="${jdbc.password}" />
	    <property name="initialSize" value="3" />
	    <property name="minIdle" value="3" />
	    <property name="maxActive" value="20" />
	    <property name="maxWait" value="60000" />
	    <property name="timeBetweenEvictionRunsMillis" value="60000" />
	    <property name="minEvictableIdleTimeMillis" value="300000" />
	    <property name="testWhileIdle" value="true" />
	    <property name="testOnBorrow" value="false" />
	    <property name="testOnReturn" value="false" />
	    <property name="filters" value="stat" />
</bean>

<!-- 3.配置动态数据源 -->
<bean class="com.mini.core.dynamic.DynamicDataSource">
	<property name="defaultTargetDataSource" ref="dataSource"></property>
	<property name="targetDataSources">
        <map key-type="java.lang.String">
            <entry key="key1" value-ref="dataSource" />
        </map>
    </property>
</bean>

####动态数据源配置说明#### defaultTargetDataSource:配置默认数据源;
targetDataSources:配置数据源,key为数据源名称(任意值),value-ref指向数据源; entityPackage:配置实体所在的包,多个包用逗号分隔;

####配置扫描说明#### 主要功能是初始化Entity的RowMapper,以及table、id等映射;

<!--扫描自动注入MiniDao-->
<context:component-scan base-package="com.mini"/>

如下配置如果配置了则会在初始化的时候将实体信息加载到内存,如果不配置则会动态加载到内存(为提高程序启动的效率,建议开发阶段不要配置)

<!--扫描实体需要配置-->
<bean id="databaseRouter" class="com.mini.core.DatabaseRouter">
	<property name="entityPackage" value="com.mini" />
</bean>

##五、例子(参考代码中的example包,可以使用user.sql创建测试数据库及表结构)

增删改的代码示例:

/**
 * 测试插入强类型实例User
 */
public static int testInsert() {
    User user = new User();
    user.setCreateTime(new Date()) .setName("username") .setType(new Random().nextInt(5));
    return dao.insert(user);
}

/**
 * 测试插入强类型实例Record
 */
public static int testInsert2() {
    Record record = new Record("users","id");
    record.set("id", new Random().nextInt(100)) .set("name", "username") 
    .set("type", new Random().nextInt(5)).set("password", "000000");
    return dao.insert(record);
}

/**
 * 更新强类型实例
 * @return
 */
public static int testUpdate() {
    User user = new User();
    user.setName("hello_update");
    return dao.update(user);
}

/**
 * 更新弱类型记录
 * @return
 */
public static int testUpdateRecord() {
    Record record = new Record();
    record.setTableName("users");
    record.setPrimaryKeys("id");
    record.set("id", "8").set("name", "record_update");
    return dao.update(record);
}

/**
 * 删除强类型实体
 * @return
 */
public static int testDelete() {
    User user = new User();
    user.setId("1");
    return dao.delete(user);
}

/**
 * 删除弱类型记录
 * @return
 */
public static int testDeleteRecord() {
    Record record = new Record();
    record.setTableName("users");
    record.setPrimaryKeys("id");
    record.set("id", "8");
    return dao.delete(record);
}

查询分页代码示例:

/**
 * 无参强类型分页
 */
public static List<User> testGetPage() {
    String sql = "select * from users where id < 8 order by id desc";
    List<User> users = dao.paginate(sql, 2, 2, User.class);
    return users;
}

/**
 * 有参强类型分页
 */
public static List<User> testGetPage2() {
    String sql = "select * from users where id < ? order by id desc";
    List<User> users = dao.paginate(sql, 2, 2, User.class, 18);
    return users;
}

/**
 * 无参弱类型分页
 */
public static List<Record> testGetPage3() {
    String sql = "select id,name from users where id < 8 order by id desc";
    return dao.paginate(sql, 2, 2,Record.class);
}

/**
 * 有参弱类型分页
 */
public static List<Record> testGetPage4() {
    String sql = "select id,name from users where id < ? order by id desc";
    return dao.paginate(sql, 2, 2, Record.class, 88);
}
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2016 沈晓军 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于spring jdbc的上层封装,底层jdbc操作基于JdbcTemplate,支持MySql、SqlServer、Oracle数据库,强弱类型完美结合 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/lyzhanghai/MiniJdbc.git
git@gitee.com:lyzhanghai/MiniJdbc.git
lyzhanghai
MiniJdbc
MiniJdbc
master

搜索帮助

14c37bed 8189591 565d56ea 8189591