159 lines
5.3 KiB
Markdown
159 lines
5.3 KiB
Markdown
# DB数据源
|
||
   DataSource是数据层操作的抽象接口，不仅用于关系型数据库，还支持内存、Mongodb、ElasticSearch等数据源，redkale内置了内存版DataSource，官方扩展包```redkale-plugins```提供了Mongodb、ElasticSearch的实现。<br>
|
||
   DataSource几乎所有操作都提供同步与异步两种方法，对性能要求高的可以采用异步方式，例如使用vertx实现的DataSqlSource。
|
||
## 注解说明
|
||
|注解类名 | 功能描述|
|
||
| --- | --- |
|
||
|@Column |标记字段，与JPA用法一致 |
|
||
|@Entity |标记实体类，与JPA用法一致 |
|
||
|@Id |标记主键字段，与JPA用法一致 |
|
||
|@Table |标记表的别名，与JPA用法一致 |
|
||
|@Transient |标记是否为表对应的字段，与JPA用法一致 |
|
||
|@VirtualEntity |用于非数据库表对应的Entity类，且仅用于开启缓存模式的DataSource |
|
||
|@DistributeTable |标记表进行分表分库存储, 与DistributeTableStrategy接口结合使用 |
|
||
|@FilterColumn |用于FilterBean过滤类的字段设置 |
|
||
|@FilterJoinColumn |用于FilterBean过滤类的关联表字段设置 |
|
||
|@FilterGroup | 用于FilterBean过滤类的过滤条件分组设置 |
|
||
|
||
## 操作方法
|
||
|系列方法 | 功能描述|
|
||
| --- | --- |
|
||
|insert |插入实体 |
|
||
|delete |删除实体 |
|
||
|update |更新实体 |
|
||
|updateColumn |更新数据的部分字段 |
|
||
|find |查找单个对象 |
|
||
|queryList |查询对象的List集合 |
|
||
|querySheet |查询对象的Sheet页式集合 |
|
||
|getNumberXXX |统计查询，用于查询字段的总和、最大值、平均值等数据 |
|
||
|queryColumnXXX |单个字段数据查询和字段的统计查询 |
|
||
|nativeXXX |直接运行SQL语句，用于复杂的关联查询与更新(仅限DataSqlSource) |
|
||
|
||
## 配置数据源
|
||
```properties
|
||
redkale.datasource.platf.url = jdbc:mysql://127.0.0.1:3306/platf?serverTimezone=UTC&characterEncoding=utf8
|
||
redkale.datasource.platf.user = root
|
||
redkale.datasource.platf.password = pwd123
|
||
```
|
||
|
||
## pom依赖
|
||
   使用jdbc驱动：
|
||
```xml
|
||
<dependency>
|
||
<groupId>com.mysql</groupId>
|
||
<artifactId>mysql-connector-j</artifactId>
|
||
<version>8.2.0</version>
|
||
</dependency>
|
||
```
|
||
|
||
   使用vertx-mysql-client实现, 需要依赖官方扩展包 ```redkale-plugins```：
|
||
```xml
|
||
<dependency>
|
||
<groupId>org.redkalex</groupId>
|
||
<artifactId>redkale-plugins</artifactId>
|
||
<version>2.8.0</version>
|
||
</dependency>
|
||
|
||
<dependency>
|
||
<groupId>io.vertx</groupId>
|
||
<artifactId>vertx-mysql-client</artifactId>
|
||
<version>4.5.1</version>
|
||
</dependency>
|
||
```
|
||
|
||
## 增删改
|
||
```java
|
||
@Data
|
||
public class Account {
|
||
//男
|
||
public static final short GENDER_MALE = 1;
|
||
|
||
//女
|
||
public static final short GENDER_FEMALE = 2;
|
||
|
||
@Id
|
||
@Column(name = "account_id")
|
||
private String accountid;
|
||
|
||
@Column(name = "account_name")
|
||
private String accountName;
|
||
|
||
private int age;
|
||
|
||
private short gender;
|
||
|
||
private String remark;
|
||
|
||
@Column(name = "create_time", updatable = false)
|
||
private long createTime;
|
||
}
|
||
```
|
||
|
||
  新增实体对象：
|
||
```java
|
||
@Resource(name = "platf")
|
||
private DataSource source;
|
||
|
||
public void insertTest() {
|
||
//新增单个
|
||
Account account = new Account();
|
||
account.setAccountid("account1");
|
||
account.setAccountName("Hello");
|
||
account.setCreateTime(System.currentTimeMillis());
|
||
source.insert(account);
|
||
|
||
//异步新增多个
|
||
Account a1 = new Account();
|
||
a1.setAccountid("account1");
|
||
a1.setAccountName("Hello1");
|
||
a1.setCreateTime(System.currentTimeMillis());
|
||
Account a2 = new Account();
|
||
a2.setAccountid("account2");
|
||
a2.setAccountName("Hello2");
|
||
a2.setCreateTime(System.currentTimeMillis());
|
||
source.insertAsync(a1, a2);
|
||
}
|
||
```
|
||
|
||
  修改实体对象：
|
||
```java
|
||
//更新单个字段
|
||
source.updateColumn(Account.class, "account1", Account::getRemark, "新备注");
|
||
|
||
//更新多个字段
|
||
source.updateColumn(Account.class, "account1",
|
||
ColumnValue.set(Account::getAccountName, "新名称"),
|
||
ColumnValue.set(Account::getRemark, "新备注"),
|
||
ColumnValue.inc(Account::getAge, 2)); //年龄+2
|
||
|
||
//更新多个字段
|
||
Account account = new Account();
|
||
account.setAccountid("account1");
|
||
account.setAccountName("新名称");
|
||
account.setRemark("新备注");
|
||
source.updateColumn(account, "accountName", "remark");
|
||
//或者
|
||
source.updateColumn(account, Account::getAccountName, Account::getRemark);
|
||
|
||
//更新整个对象
|
||
Account one = new Account();
|
||
one.setAccountid("account1");
|
||
one.setAccountName("Hello1");
|
||
one.setCreateTime(System.currentTimeMillis());
|
||
source.update(one); //createTime不会被更新，因字段设置了@Column(updatable=false)
|
||
|
||
//过滤更新
|
||
source.updateColumn(Account.class, FilterNodes.lt(Account::getAge, 16),
|
||
ColumnValue.set(Account::getRemark, "不满16岁是青少年"));
|
||
```
|
||
|
||
  删除实体：
|
||
```java
|
||
//根据主键值删除
|
||
Account account = new Account();
|
||
account.setAccountid("account1");
|
||
source.delete(account);
|
||
|
||
//过滤删除， 删除16以下男生
|
||
source.delete(Account.class, FilterNodes.lt(Account::getAge, 16).and("gender", GENDER_MALE));
|
||
``` |