127 lines
14 KiB
HTML
127 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-us">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<title>RedKale - Java 开源框架</title>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
|
||
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
|
||
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
|
||
<link rel="stylesheet" type="text/css" href="stylesheets/highlight.css" media="screen">
|
||
</head>
|
||
<body>
|
||
<section class="page-header">
|
||
<a href="index.html" class="project-name">RedKale</a>
|
||
<h2 class="project-tagline"></h2>
|
||
<a href="redkale.html" class="btn">RedKale 入门</a>
|
||
<a href="convert.html" class="btn">Convert 组件</a>
|
||
<a href="service.html" class="btn">Service 组件</a>
|
||
<a href="source.html" class="btn">Source 组件</a>
|
||
<a href="net.html" class="btn">Net 组件</a>
|
||
<a href="watch.html" class="btn" style="display: none;">Watch 组件</a>
|
||
<a href="javadoc/index.html" target="_blank" class="btn">Javadoc API</a>
|
||
<a href="https://github.com/wentch/redkale" target="_blank" class="btn">Github 源码</a>
|
||
</section>
|
||
|
||
<section class="main-content">
|
||
<h3><a id="source_intro" class="anchor" href="#" aria-hidden="true"><span class="octicon octicon-link"></span></a>Source 组件介绍</h3>
|
||
|
||
<p> Source 主要为数据源提供简易的操作接口，使底层的具体数据源(传统数据库、文件系统、内存数据库、Memcached/Redis缓存)对上层是透明的。其提供两种类型的数据源：DataSource 和 CacheSource。DataSource 为数据库或内存数据库，提供类似JPA、Hibernate的接口与功能。CacheSource 为缓存数据提供类似Memcached、Redis的接口和功能。两者也提供了异步接口(基于<a href="service.html#service_remote" target="_blank">远程模式Service</a>)。<br/></p>
|
||
|
||
<h3><a id="datasource_study" class="anchor" href="#" aria-hidden="true"><span class="octicon octicon-link"></span></a>DataSource 入门</h3>
|
||
<p>
|
||
JPA虽然已经提供了简洁成熟的数据库操作接口，但当数据、业务量很庞大的时候就显得捉襟见肘，与JPA相比，DataSource有以下几个特点：<br/>
|
||
1、简易的过滤查询接口，但仅支持简单的表关联查询。 <br/>
|
||
2、分布式的主键的分布式自增策略。 <br/>
|
||
3、动态更新变更后的数据库连接参数。 <br/>
|
||
4、读写分离的简易配置。 <br/>
|
||
5、进程间的缓存自动同步。 <br/>
|
||
数据库操作方面常见的是过滤查询操作，JPA规范中的JPQL虽然简化了SQL，但是对于动态产生的过滤条件,使用者还是无法免去组装过滤条件的过程(无论JPQL还是CriteriaQuery), DataSource定义了FilterBean接口可以省略组装条件的过程，FilterNode提供了类似CriteriaQuery的功能，且这两种对象都可以序列化，给<a href="service.html#service_remote" target="_blank">远程模式Service</a>提供了基础，微服务架构提倡服务之间尽量降低耦合，因此DataSource仅支持简单的关联查询，复杂的表关联查询或统计应放在数据分析系统中。一个服务通常部署多个进程，若用JPA的缓存则进程之间的缓存无法同步，而DataSource采用SNCP协议即可方便地达到自动同步缓存功能。JPA无法在主数据库异常时动态切换到备份数据库，DataSource会监听<a href="#source_confxml">persistence.xml</a>文件，当文件配置发生变化时自动切换新的数据库配置。<br/>
|
||
为了降低学习成本，DataSource重用了JPA里的部分注解与配置文件，使用方法基本相同，与JPA用法唯一区别是注解只能标记于字段，不能标记在方法上。
|
||
</p>
|
||
<table style="margin: auto;">
|
||
<tr><th>注解类名</th><th>功能描述</th></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Cacheable</td><td>标记Entity类是否需要缓存，与JPA用法一致</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Column</td><td>标记字段，只使用其name()、insertable()、updatable()属性</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Entity</td><td>JPA的Entity类必须标记为@Entity, 而RedKale不强制要求，所以该注解一般无用</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.GeneratedValue</td><td>仅用于标记主键是否为数据库自增长，其内值的两属性废弃</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.GenerationType</td><td>被@GeneratedValue的属性引用，在RedKale内不被使用到</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Id<td>标记主键字段，与JPA用法一致</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Table<td>标记表的别名，与JPA用法一致</td></tr>
|
||
<tr><td style="text-align: left;">javax.persistence.Transient<td>标记是否为表对应的字段，与JPA用法一致</td></tr>
|
||
<tr><td style="text-align: center;font-size: 0.9rem;" colspan="2"><b>以下是RedKale自定义的注解</b></td></tr>
|
||
<tr><td style="text-align: left;"><b>@VirtualEntity</b></td><td>用于非数据库表对应的Entity类，且仅用于开启缓存模式的DataSource</td></tr>
|
||
<tr><td style="text-align: left;"><b>@DistributeGenerator</b></td><td>标记主键是否采用分布式自增长策略，不能与@GeneratedValue同用</td></tr>
|
||
<tr><td style="text-align: left;"><b>@DistributeTables</b></td><td>当多个表的主键唯一性公用时需要该注解</td></tr>
|
||
<tr><td style="text-align: left;"><b>@FilterColumn</b></td><td>用于FilterBean过滤类的字段设置</td></tr>
|
||
<tr><td style="text-align: left;"><b>@FilterJoinColumn</b></td><td>用于FilterBean过滤类的关联表字段设置</td></tr>
|
||
<tr><td style="text-align: left;"><b>@FilterGroup</b></td><td>用于FilterBean过滤类的过滤条件分组设置</td></tr>
|
||
</table>
|
||
<p>
|
||
操作数据源主要使用的对象有 DataSource、FilterBean、FilterNode。DataSource 提供的接口分几种系列：
|
||
</p>
|
||
|
||
<table style="margin: auto;">
|
||
<tr><th>系列方法</th><th>功能描述</th></tr>
|
||
<tr><td style="text-align: left;">insert</td><td>插入数据</td></tr>
|
||
<tr><td style="text-align: left;">delete</td><td>删除数据</td></tr>
|
||
<tr><td style="text-align: left;">update</td><td>更新数据</td></tr>
|
||
<tr><td style="text-align: left;">updateColumnXXX</td><td>更新数据的部分字段</td></tr>
|
||
<tr><td style="text-align: left;">getNumberResult</td><td>统计查询，用于查询字段的总和、最大值、平均值等数据</td></tr>
|
||
<tr><td style="text-align: left;">queryColumnXXX<td>单个字段数据查询和字段的统计查询</td></tr>
|
||
<tr><td style="text-align: left;">find<td>查找单个对象</td></tr>
|
||
<tr><td style="text-align: left;">queryList<td>查询对象的List集合</td></tr>
|
||
<tr><td style="text-align: left;">querySheet</td><td>查询对象的Sheet页式集合</td></tr>
|
||
<tr><td style="text-align: left;">directXXX<td>直接运行SQL语句，用于复杂的关联查询与更新</td></tr>
|
||
</table>
|
||
<p>
|
||
以上接口除了directXXX，其他都有等同的异步接口。insert、delete、update接口与JPA同名接口用法一样。DataSource提供了丰富的查询接口，且有独特的翻页查询功能。
|
||
</p>
|
||
|
||
<p>未完待续…… <br/>
|
||
</p>
|
||
<h3><a id="source_confxml" href="#" aria-hidden="true"><span class="octicon octicon-link"></span></a>persistence.xml 配置说明</h3>
|
||
<div class="highlight"><pre><span class="c"><!-- 其配置算是标准的JPA配置文件的缩略版 --></span>
|
||
<span class="nt"><persistence></span>
|
||
<span class="c"><!-- 系统基本库 --></span>
|
||
<span class="nt"><persistence-unit</span> <span class="na">name=</span><span class="s">"demouser"</span><span class="nt">></span>
|
||
<span class="c"><!-- 为NONE表示不启动缓存，@Cacheable 失效； 非NONE值(通常用ALL)表示开启缓存。 --></span>
|
||
<span class="nt"><shared-cache-mode></span>NONE<span class="nt"></shared-cache-mode></span>
|
||
<span class="nt"><properties></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.url"</span> <span class="na">value=</span><span class="s">"jdbc:mysql://127.0.0.1:3306/dbuser?characterEncoding=utf8"</span><span class="nt">/></span>
|
||
<span class="c"><!-- </span>
|
||
<span class="c"> javax.persistence.jdbc.driver在JPA的值是JDBC驱动，RedKale有所不同，值应该是javax.sql.DataSource的子类。 </span>
|
||
<span class="c"> 为了兼容用户习惯，RedKale内置常见JDBC驱动到javax.sql.DataSource的映射关系：</span>
|
||
<span class="c"> com.mysql.jdbc.Driver —————— com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource</span>
|
||
<span class="c"> org.mariadb.jdbc.Driver —————— org.mariadb.jdbc.MySQLDataSource</span>
|
||
<span class="c"> oracle.jdbc.driver.OracleDriver —————— oracle.jdbc.pool.OracleConnectionPoolDataSource</span>
|
||
<span class="c"> com.microsoft.sqlserver.jdbc.SQLServerDriver —————— com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource</span>
|
||
<span class="c"> 因此 com.mysql.jdbc.Driver 会被自动转换成 com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource</span>
|
||
<span class="c"> --></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.driver"</span> <span class="na">value=</span><span class="s">"com.mysql.jdbc.Driver"</span><span class="nt">/></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.user"</span> <span class="na">value=</span><span class="s">"root"</span><span class="nt">/></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.password"</span> <span class="na">value=</span><span class="s">"123456"</span><span class="nt">/></span>
|
||
<span class="nt"></properties></span>
|
||
<span class="nt"></persistence-unit></span>
|
||
<span class="c"><!-- IM消息库 --></span>
|
||
<span class="nt"><persistence-unit</span> <span class="na">name=</span><span class="s">"demoim"</span><span class="nt">></span>
|
||
<span class="nt"><shared-cache-mode></span>NONE<span class="nt"></shared-cache-mode></span>
|
||
<span class="nt"><properties></span>
|
||
<span class="c"><!-- jdbc:mysql://127.0.0.1:3306/dbim?autoReconnect=true&amp;autoReconnectForPools=true&amp;characterEncoding=utf8 --></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.url"</span> <span class="na">value=</span><span class="s">"jdbc:mysql://127.0.0.1:3306/dbim?characterEncoding=utf8"</span><span class="nt">/></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.driver"</span> <span class="na">value=</span><span class="s">"com.mysql.jdbc.Driver"</span><span class="nt">/></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.user"</span> <span class="na">value=</span><span class="s">"root"</span><span class="nt">/></span>
|
||
<span class="nt"><property</span> <span class="na">name=</span><span class="s">"javax.persistence.jdbc.password"</span> <span class="na">value=</span><span class="s">"123456"</span><span class="nt">/></span>
|
||
<span class="nt"></properties></span>
|
||
<span class="nt"></persistence-unit></span>
|
||
<span class="nt"></persistence></span></pre></div>
|
||
|
||
<footer class="site-footer">
|
||
<span class="site-footer-owner"><a href="https://github.com/wentch/redkale">RedKale</a> © <a href="https://github.com/wentch">wentch</a> 欢迎加入RedKale技术交流QQ群: 527523235</span>
|
||
</footer>
|
||
|
||
</section>
|
||
|
||
</body>
|
||
</html>
|