# sail-jdbc
**Repository Path**: sohu1979/JdbcTool
## Basic Information
- **Project Name**: sail-jdbc
- **Description**: 简单易上手的多源数据库操作工具
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: rm-spring
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 5
- **Created**: 2024-06-17
- **Last Updated**: 2024-06-17
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# sail-jdbc
[//]: # ()
[//]: # ()
[//]: # (使用[idea](https://www.jetbrains.com/?from=jdbcTool) 开发)
#### 介绍
sail-jdbc是一款开源的关系型数据库操作工具,对数据库实际操作中常见的增、删、改、查做了封装,提供可配置的数据库操作日志功能,从而简化了日常的开发工作.
目前已经支持MySql、SqlServer、Oracle、postgresql等主流数据库,取名sail是希望它能为项目运转的中间力量小巧,轻量,便于使用.
#### 特性
- 支持大部分主流关系型数据库
- 可动态加载数据库
- 支持多数据源
- 集成duird丰富监控功能
- 提供可配置的数据库操作日志功能
#### 使用说明
默认在classpath下wood.json中以json格式配置数据库信息,也可在环境变量中以参数configFile指定文件名(ex:java -jar demo.jar --configFile=wood.json)
- json配置文件示例
```
{
//多数据源配置
"dataBaseConfig": [
{
"sourceName": "mainDb",
"type": "mysql",
"ip": "*",
"port": 3306,
"loginName": "*",
"pwd": "*",
"endParam": "singlewood?serverTimezone=UTC",
"queryTimeOut": 1
}
],
//jdbc模板为运行中动态生成数据源提供模板支持
"dataBaseTemplate": [
{
"type": "mysql",
"driverClassName": "com.mysql.cj.jdbc.Driver",
"port": 3306,
"jdbcTemplate": "jdbc:mysql://{{IP}}:{{PORT}}/{{END_PARAM}}"
},
{
"type": "oracle",
"driverClassName": "oracle.jdbc.driver.OracleDriver",
"port": 1521,
"jdbcTemplate": "jdbc:oracle:thin:@{{IP}}:{{PORT}}/{{END_PARAM}}"
},
{
"type": "postgres",
"driverClassName": "org.postgresql.Driver",
"port": 5432,
"jdbcTemplate": "jdbc:postgresql://{{IP}}:{{PORT}}/{{END_PARAM}}"
},
{
"type": "sqlserver",
"driverClassName": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"port": 1433,
"jdbcTemplate": "jdbc:sqlserver://{{IP}}:{{PORT}};{{END_PARAM}}"
}
],
//通过配置druidConfig属性自定义默认druid配置 更多druid参数可自行百度
"druidConfig": {
"initialSize": 22,
"maxActive": 30
},
"logConfig": {
//文件日志
"file": {
"enable": false,
"exceptionLogPath": "",
"toolLogPath": ""
},
//控制台日志
"console": {
"enable": true
},
//超时日志
"timeout": {
"enable": false,
"maxLostTime": "20000",
"fileName": "test-log"
}
}
}
```
- 实体类示例
```
@TableName("ST_PARM")
@PrimaryKey("PARM_ID")
public class StParm implements Serializable {
/**
* 参数编号
*/
@FieldColumn("PARM_ID")
@JSONField(name = "parmId", alternateNames = {"parmId", "PARM_ID"})
private String parmId;
/**
* 参数分类
*/
@FieldColumn("CATEGORY")
@JSONField(name = "category", alternateNames = {"category", "CATEGORY"})
private String category;
}
```
### 使用示例
1. 初始化数据连接
```
//1.使用默认主配
JdbcDataBase db = DataSourceFactory.getJdbcDataBase();
//2.使用配置名匹配加载
JdbcDataBase db = DataSourceFactory.getJdbcDataBase("sourceName");
//3.依赖模板方式(可以通过ConfigCenter.addDataBaseTemplate动态添加模板)
DbInfo info = new DbInfo() {{
setSourceName("testDb");
setType("mysql");
setIp("*.*.*.*");
setPort(3306);
setLoginName("*");
setPwd("*");
setEndParam("singlewood?serverTimezone=UTC");
}};
JdbcDataBase db = DataSourceFactory.getJdbcDataBaseByInfo(info, true);
//4.不依赖配置模板方式
DbInfo info = new DbInfo() {{
setConnectStr("jdbc:mysql://*.*.*.*:3306/singlewood?serverTimezone=UTC");
setDriverClassName("com.mysql.cj.jdbc.Driver");
setLoginName("*");
setPwd("*");
}};
JdbcDataBase db = DataSourceFactory.getJdbcDataBaseByInfo(info, false);
```
2. 具体使用
- 新增单个实体(配合带本工具注解的实体类使用)
```
db.insert(BsDiary.class,new BsDiary(){{
setDHead("head");
....
}});
```
- 根据id更新
```
BsDiary diary=db.findRowById(BsDiary.class,"42");
diary.setDHead("update");
db.updateById(BsDiary.class,diary);
```
- 关联id单个删除(配合带本工具注解的实体类使用)
```
db.delectbyId(BsDiary.class,"1");
```
- 关联id多个删除(配合带本工具注解的实体类使用)
```
db.delectbyIds(BsDiary.class, new ArrayList<>() {{
add("1");
add("2");
...
}});
```
- 单一简单类型数据查询
```
db.querySingleTypeResult("select head from bs_diary where d_diaryId=?",String.class,"42");
```
- 多行简单类型数据查询
```
db.querySingleTypeList("select head from bs_diary ",String.class);
```
- 单一实体数据查询(配合带本工具注解的实体类使用)
```
db.queryOneRow("select * from bs_diary where d_diaryId=?",BsDiary.class,"42");
```
- 多行实体数据查询(配合带本工具注解的实体类使用)
```
db.queryList("select * from bs_diary ",BsDiary.class);
```
- Map查询
```
db.queryForMap("select * from bs_diary where d_diaryId=?","42");
```
- list