【Mycat】Mycat核心开发者带你看尽Mycat三大核心配置文件

刺骨的言语ヽ痛彻心扉 2021-09-02 08:20 358阅读 0赞

## 写在前面 ##

> 在分布式数据库中间件领域，Mycat和ShardingSphere可以说是在开源界有着相当重要的位置，不少小伙伴也在问我：Mycat和sharding-jdbc哪个好呀！其实，就我本身而言，我作为Mycat的开发者，也深度分析过ShardingSphere的源码。可以这么说：各有各的优势吧！其实，针对ShardingSphere，我也跟ShardingSphere的创始人亮哥聊过，从他那里确实学到了不少有价值的东西。后续我也可能会写一部关于分布式数据库的书籍，也说不定会将Mycat和ShardingSphere写进去呢。到时肯定是要请亮哥帮我写推荐序呀！哈哈哈。。。
> 
> #  #
> 
> 好了，说了这么多，今天给大家分享下Mycat的三大核心配置文件：server.xml、schema.xml和rule.xml。

## server.xml ##

server.xml几乎保存了所有mycat需要的系统配置信息。其在代码内直接的映射类为SystemConfig类。现在就对这个文件中的配置进行相关的介绍

### user标签 ###

<user name="test">
    	<property name="password">test</property>
    	<property name="schemas">TESTDB</property>
    	<property name="readOnly">true</property>
    </user>

server.xml中的标签本就不多，这个标签主要用于定义登录mycat的用户和权限。例如上面的例子中，我定义了一个用户，用户名为test、密码也为test，可访问的schema也只有TESTDB一个。如果我在schema.xml中定义了多个schema，那么这个用户是无法访问其他的schema。在mysql客户端看来则是无法使用use切换到这个其他的数据库。如果使用了use命令，则mycat会报出这样的错误提示：ERROR 1044 (HY000): Access denied for user ‘test’ to database 'xxx’这个标签嵌套的property标签则是具体声明的属性值，正如上面的例子。我们可以修改user标签的name属性来指定用户名；修改password内的文本来修改密码；修改readOnly为true 或false来限制用户是否只是可读的；修改schemas内的文本来控制用户可放问的schema；修改schemas内的文本来控制用户可访问的schema，同时访问多个schema的话使用 , 隔开，例如:

<property name="schemas">TESTDB,db1,db2</property>

### system标签 ###

这个标签内嵌套的所有property标签都与系统配置有关，请注意，下面我会省去标签property直接使用这个标签的name属性内的值来介绍这个属性的作用。

**defaultSqlParser属性**

由于mycat最初是时候Foundation DB的sql解析器，而后才添加的Druid的解析器。所以这个属性用来指定默认的解析器。目前的可用的取值有：druidparser和 fdbparser。使用的时候可以选择其中的一种，目前一般都使用druidparser。

**processors属性**

这个属性主要用于指定系统可用的线程数，默认值为Runtime.getRuntime().availableProcessors()方法返回的值。主要影响processorBufferPool、processorBufferLocalPercent、processorExecutor属性。NIOProcessor的个数也是由这个属性定义的，所以调优的时候可以适当的调高这个属性。

**processorBufferChunk属性**

这个属性指定每次分配Socket Direct Buffer的大小，默认是4096个字节。这个属性也影响buffer pool的长度。

**processorBufferPool属性**

这个属性指定bufferPool计算 比例值。由于每次执行NIO读、写操作都需要使用到buffer，系统初始化的时候会建立一定长度的buffer池来加快读、写的效率，减少建立buffer的时间。

### 两个主要的buffer池 ###

BufferPool和ThreadLocalPool

BufferPool由ThreadLocalPool组合而成，每次从BufferPool中获取buffer都会优先获取ThreadLocalPool中的buffer，未命中之后才会去获取BufferPool中的buffer。也就是说ThreadLocalPool是作为BufferPool的二级缓存，每个线程内部自己使用的。当然，这其中还有一些限制条件需要线程的名字是由$\_开头。然而，BufferPool上的buffer则是每个NIOProcessor都共享的。默认这个属性的值为：

默认bufferChunkSize(4096) * processors属性 *　1000 BufferPool的总长度 =  bufferPool / bufferChunk。

若bufferPool不是bufferChunk的整数倍，则总长度为前面计算得出的商 + 1 假设系统线程数为4，其他都为属性的默认值，则：

bufferPool ＝　4096 *　4 * 1000
     BufferPool的总长度 : 4000 = 16384000 / 4096

**processorBufferLocalPercent属性**

前面提到了ThreadLocalPool。这个属性就是用来控制分配这个pool的大小用的，但其也并不是一个准确的值，也是一个比例值。这个属性默认值为100。

线程缓存百分比 = bufferLocalPercent / processors属性。

例如，系统可以同时运行4个线程，使用默认值，则根据公式每个线程的百分比为25。最后根据这个百分比来计算出具体的。

ThreadLocalPool的长度公式如下：

ThreadLocalPool的长度 = 线程缓存百分比 * BufferPool长度 / 100

假设BufferPool的长度为 4000，其他保持默认值。  
那么最后每个线程建立上的ThreadLocalPool的长度为： 1000 = 25 \* 4000 / 100

**processorExecutor属性**

这个属性主要用于指定NIOProcessor上共享的businessExecutor固定线程池大小。mycat在需要处理一些异步逻辑的时候会把任务提交到这个线程池中。新版本中这个连接池的使用频率不是很大了，可以设置一个较小的值。

**sequnceHandlerType属性**

指定使用Mycat全局序列的类型。0为本地文件方式，1为数据库方式。默认是使用本地文件方式，文件方式主要只是用于测试使用。

**TCP连接相关属性**

StandardSocketOptions.SO_RCVBUF
    StandardSocketOptions.SO_SNDBUF
    StandardSocketOptions.TCP_NODELAY

以上这三个属性，分别由：

*  frontSocketSoRcvbuf 默认值： 1024 \* 1024
 *  frontSocketSoSndbuf 默认值： 4 \* 1024 \* 1024
 *  frontSocketNoDelay 默认值： 1
 *  backSocketSoRcvbuf 默认值： 4 \* 1024 \* 1024
 *  backSocketSoSndbuf 默认值： 1024 \* 1024
 *  backSocketNoDelay 默认值： 1

各自设置前后端TCP连接参数。Mycat在每次建立前、后端连接的时候都会使用这些参数初始化连接。可以按系统要求适当的调整这些buffer的大小。TCP连接参数的定义，可以查看Javadoc。  
MySQL连接相关属性初始化mysql前后端连接所涉及到的一些属性：

*  packetHeaderSize : 指定Mysql协议中的报文头长度。默认4。
 *  maxPacketSize : 指定Mysql协议可以携带的数据最大长度。默认16M。
 *  idleTimeout : 指定连接的空闲超时时间。某连接在发起空闲检查下，发现距离上次使用超过了空闲时间，那么这个连接会被回收，就是被直接的关闭掉。默认30分钟。
 *  charset : 连接的初始化字符集。默认为utf8。
 *  txIsolation : 前端连接的初始化事务隔离级别，只在初始化的时候使用，后续会根据客户端传递过来的属性对后端数据库连接进行同步。默认为REPEATED\_READ。
 *  sqlExecuteTimeout:SQL执行超时的时间，Mycat会检查连接上最后一次执行SQL的时间，若超过这个时间则会直接关闭这连接。默认时间为300秒。

**周期间隔相关属性**

mycat中有几个周期性的任务来异步的处理一些我需要的工作。这些属性就在系统调优的过程中也是比不可少的。

*  processorCheckPeriod : 清理NIOProcessor上前后端空闲、超时和关闭连接的间隔时间。默认是1秒。
 *  dataNodeIdleCheckPeriod : 对后端连接进行空闲、超时检查的时间间隔，默认是60秒。
 *  dataNodeHeartbeatPeriod : 对后端所有读、写库发起心跳的间隔时间，默认是10秒。

**服务相关属性**

这里介绍一个与服务相关的属性，主要会影响外部系统对myact的感知。

*  bindIp : mycat服务监听的IP地址，默认值为0.0.0.0。
 *  serverPort : 定义mycat的使用端口，默认值为8066。
 *  managerPort : 定义mycat的管理端口，默认值为9066。

## schema.xml ##

schema.xml作为MyCat中重要的配置文件之一，管理着MyCat的逻辑库、表、分片规则、DataNode以及DataSource。弄懂这些配置，是正确使用MyCat的前提。这里就一层层对该文件进行解析。

<?xml version="1.0"?>
    <!DOCTYPE mycat:schema SYSTEM "schema.dtd">
    <mycat:schema xmlns:mycat="http://org.opencloudb/">
     
    	<schema name="TESTDB" checkSQLschema="false" sqlMaxLimit="100">
    		<table name="user" dataNode="dn1,dn2" rule="auto-sharding-long" />
    		<table name="stat_tcp_stream" dataNode="dn2,dn3" rule="auto-sharding-long" />
    	</schema>
    	<dataNode name="dn1" dataHost="localhost1" database="mpos_tshark_miner_2014" />
    	<dataNode name="dn2" dataHost="localhost2" database="mpos_tshark_miner2014" />
    	<dataNode name="dn3" dataHost="localhost3" database="mpos_tshark_hrtel" />
    	
    	<dataHost name="localhost1" maxCon="1000" minCon="10" balance="0" dbType="mysql" dbDriver="jdbc" writeType="0" switchType="1" slaveThreshold="100">
    		<heartbeat>select user()</heartbeat>
    		<writeHost host="hostM1" url="jdbc:mysql://192.168.1.150:5029" user="root" password="root"></writeHost>
    	</dataHost>
    	<dataHost name="localhost2" maxCon="1000" minCon="1" balance="0" dbType="mysql" dbDriver="jdbc"> 
    		<heartbeat> 		</heartbeat>
    		 <writeHost host="hostM2" url="jdbc:mysql://192.168.1.150:5029" user="root" password="root"></writeHost> 
    	 </dataHost>		
    	<dataHost name="localhost3" maxCon="1000" minCon="1" balance="0" dbType="mysql" dbDriver="jdbc"> 
    		<heartbeat> 		</heartbeat>
    		 <writeHost host="hostM3" url="jdbc:mysql://192.168.1.150:5029" user="root" password="root"></writeHost> 
    	 </dataHost>		 
    </mycat:schema>

### schema标签 ###

**dataNode**

该属性用于绑定逻辑库到某个具体的database上，如果定义了这个属性，那么这个逻辑库就不能工作在分库分表模式下了。也就是说对这个逻辑库的所有操作会直接作用到绑定的dataNode上，这个schema就可以用作读写分离和主从切换，具体如下配置:

那么现在USERDB就绑定到dn1所配置的具体database上，可以直接访问这个database。当然该属性只能配置绑定到一个database上，不能绑定多个dn。

**checkSQLschema**

当该值设置为 true 时，如果我们执行语句 **select \* from TESTDB.travelrecord;** 则MyCat会把语句修改为 **select \* from travelrecord;** 。即把表示schema的字符去掉，避免发送到后端数据库执行时报 **（ERROR 1146 (42S02): Table ‘testdb.travelrecord’ doesn’t exist）。** 不过，即使设置该值为 true ，如果语句所带的是并非是schema指定的名字，例如： **select \* from db1.travelrecord;** 那么MyCat并不会删除db1这个字段，如果没有定义该库的话则会报错，所以在提供SQL语句的最好是不带这个字段。

**sqlMaxLimit**

当该值设置为某个数值时。每条执行的SQL语句，如果没有加上limit语句，MyCat也会自动的加上所对应的值。例如设置值为100，执行 **select \* from TESTDB.travelrecord;** 的效果为和执行 **select \* from TESTDB.travelrecord limit 100;** 相同。不设置该值的话，MyCat默认会把查询到的信息全部都展示出来，造成过多的输出。所以，在正常使用中，还是建议加上一个值，用于减少过多的数据返回。当然SQL语句中也显式的指定limit的大小，不受该属性的约束。

### table标签 ###

Table 标签定义了MyCat中的逻辑表，所有需要拆分的表都需要在这个标签中定义。

**name属性**

定义逻辑表的表名，这个名字就如同我在数据库中执行create table命令指定的名字一样，同个schema标签中定义的名字必须唯一。

**dataNode属性**

定义这个逻辑表所属的dataNode, 该属性的值需要和dataNode标签中name属性的值相互对应。如果需要定义的dn过多可以使用如下的方法减少配置：

这里需要注意的是database属性所指定的真实database name需要在后面添加一个，例如上面的例子中，我需要在真实的mysql上建立名称为dbs0到dbs99的database。

**rule属性**

该属性用于指定逻辑表要使用的规则名字，规则名字在rule.xml中定义，必须与tableRule标签中name属性属性值一一对应。

**primaryKey属性**

该逻辑表对应真实表的主键，例如：分片的规则是使用非主键进行分片的，那么在使用主键查询的时候，就会发送查询语句到所有配置的DN上，如果使用该属性配置真实表的主键。难么MyCat会缓存主键与具体DN的信息，那么再次使用非主键进行查询的时候就不会进行广播式的查询，就会直接发送语句给具体的DN，但是尽管配置该属性，如果缓存并没有命中的话，还是会发送语句给具体的DN，来获得数据。

**type属性**

该属性定义了逻辑表的类型，目前逻辑表只有“全局表”和”普通表”两种类型。对应的配置：全局表：global。普通表：不指定该值为globla的所有表。

**autoIncrement属性**

MySQL对非自增长主键，使用last\_insert\_id()是不会返回结果的，只会返回0。所以，只有定义了自增长主键的表才可以用last\_insert\_id()返回主键值。mycat目前提供了自增长主键功能，但是如果对应的mysql节点上数据表，没有定义auto\_increment，那么在mycat层调用last\_insert\_id()也是不会返回结果的。由于insert操作的时候没有带入分片键，mycat会先取下这个表对应的全局序列，然后赋值给分片键。这样才能正常的插入到数据库中，最后使用last\_insert\_id()才会返回插入的分片键值。如果要使用这个功能最好配合使用数据库模式的全局序列。使用autoIncrement=“true” 指定这个表有使用自增长主键，这样mycat才会不抛出分片键找不到的异常。使用autoIncrement=“false” 来禁用这个功能，当然你也可以直接删除掉这个属性。默认就是禁用的。

**needAddLimit属性**

指定表是否需要自动的在每个语句后面加上limit限制。由于使用了分库分表，数据量有时会特别巨大。这时候执行查询语句，如果恰巧又忘记了加上数量限制的话。那么查询所有的数据出来，也够等上一小会儿的。所以，mycat就自动的为我们加上LIMIT 100。当然，如果语句中有limit，就不会在次添加了。这个属性默认为true,你也可以设置成false\`禁用掉默认行为。

### childTable标签 ###

childTable标签用于定义E-R分片的子表。通过标签上的属性与父表进行关联

**name属性**

定义子表的表名。

**joinKey属性**

插入子表的时候会使用这个列的值查找父表存储的数据节点。

**parentKey属性**

属性指定的值一般为与父表建立关联关系的列名。程序首先获取joinkey的值，再通过 **parentKey** 属性指定的列名产生查询语句，通过执行该语句得到父表存储在哪个分片上。从而确定子表存储的位置。

**primaryKey属性**

同table标签所描述的。

**needAddLimit属性**

同table标签所描述的。

### dataNode标签 ###

dataNode 标签定义了MyCat中的数据节点，也就是我们通常说所的数据分片。一个**dataNode** 标签就是一个独立的数据分片。例子中所表述的意思为：使用名字为lch3307数据库实例上的db1物理数据库，这就组成一个数据分片，最后，我们使用名字dn1标识这个分片。

**name属性**

定义数据节点的名字，这个名字需要是唯一的，我们需要在table标签上应用这个名字，来建立表与分片对应的关系。

**dataHost属性**

该属性用于定义该分片属于哪个数据库实例的，属性值是引用dataHost标签上定义的name属性。

**database属性**

该属性用于定义该分片属性哪个具体数据库实例上的具体库，因为这里使用两个纬度来定义分片，就是：实例+具体的库。因为每个库上建立的表和表结构是一样的。所以这样做就可以轻松的对表进行水平拆分。

### dataHost标签 ###

作为Schema.xml中最后的一个标签，该标签在mycat逻辑库中也是作为最底层的标签存在，直接定义了具体的数据库实例、读写分离配置和心跳语句。现在我们就解析下这个标签。

<dataHost name="localhost1" maxCon="1000" minCon="10" balance="0" writeType="0" dbType="mysql" dbDriver="native">
    <heartbeat>select user()</heartbeat>
    
    <writeHost host="hostM1" url="localhost:3306" user="root" password="123456">
    
    
    </writeHost>
    
    </dataHost>

**name属性**

唯一标识dataHost标签，供上层的标签使用。

**maxCon属性**

指定每个读写实例连接池的最大连接。也就是说，标签内嵌套的writeHost、readHost标签都会使用这个属性的值来实例化出连接池的最大连接数。

**minCon属性**

指定每个读写实例连接池的最小连接，初始化连接池的大小。

**balance属性**

负载均衡类型，目前的取值有3种：

*  balance=“0”, 所有读操作都发送到当前可用的writeHost上。
 *  balance=“1”，所有读操作都随机的发送到readHost。
 *  balance=“2”，所有读操作都随机的在writeHost、readhost上分发。

**writeType属性**

负载均衡类型，目前的取值有3种：

*  writeType=“0”, 所有写操作都发送到可用的writeHost上。
 *  writeType=“1”，所有写操作都随机的发送到readHost。
 *  writeType=“2”，所有写操作都随机的在writeHost、readhost分上发。

**dbType属性**

指定后端连接的数据库类型，目前支持二进制的mysql协议，还有其他使用JDBC连接的数据库。例如：mongodb、oracle、spark等。

**dbDriver属性**

指定连接后端数据库使用的Driver，目前可选的值有native和JDBC。使用native的话，因为这个值执行的是二进制的mysql协议，所以可以使用mysql和maridb。其他类型的数据库则需要使用JDBC驱动来支持。如果使用JDBC的话需要将符合JDBC 4标准的驱动JAR包放到MYCAT\\lib目录下，并检查驱动JAR包中包括如下目录结构的文件：META-INF\\services\\java.sql.Driver。在这个文件内写上具体的Driver类名，例如：com.mysql.jdbc.Driver。

### heartbeat标签 ###

这个标签内指明用于和后端数据库进行心跳检查的语句。例如,MYSQL可以使用select user()，Oracle可以使用select 1 from dual等。这个标签还有一个connectionInitSql属性，主要是当使用Oracla数据库时，需要执行的初始化SQL语句就这个放到这里面来。例如：alter session set nls\_date\_format=‘yyyy-mm-dd hh24:mi:ss’

### writeHost标签、readHost标签 ###

这两个标签都指定后端数据库的相关配置给mycat，用于实例化后端连接池。唯一不同的是，writeHost指定写实例、readHost指定读实例，组着这些读写实例来满足系统的要求。在一个dataHost内可以定义多个writeHost和readHost。但是，如果writeHost指定的后端数据库宕机，那么这个writeHost绑定的所有readHost都将不可用。另一方面，由于这个writeHost宕机系统会自动的检测到，并切换到备用的writeHost上去。这两个标签的属性相同，这里就一起介绍。

**host属性**

用于标识不同实例，一般writeHost我们使用M1，readHost我们用S1。

**url属性**

后端实例连接地址，如果是使用native的dbDriver，则一般为address:port这种形式。用JDBC或其他的dbDriver，则需要特殊指定。当使用JDBC时则可以这么写：jdbc:mysql://localhost:3306/。

**user属性**

后端存储实例需要的用户名字

**password属性**

后端存储实例需要的密码

## rule.xml ##

rule.xml里面就定义了我们对表进行拆分所涉及到的规则定义。我们可以灵活的对表使用不同的分片算法，或者对表使用相同的算法但具体的参数不同。这个文件里面主要有tableRule和function这两个标签。在具体使用过程中可以按照需求添加tableRule和function。

### tableRule标签 ###

这个标签定义表规则。定义的表规则，在rule.xml：

name 属性指定唯一的名字，用于标识不同的表规则。内嵌的rule标签则指定对物理表中的哪一列进行拆分和使用什么路由算法。columns 内指定要拆分的列名字。algorithm 使用function标签中的name属性。连接表规则和具体路由算法。当然，多个表规则可以连接到同一个路由算法上。标签内使用。让逻辑表使用这个规则进行分片。

### function标签 ###

<function name="hash-int" class="org.opencloudb.route.function.PartitionByFileMap">
    	<property name="mapFile">partition-hash-int.txt</property>
    </function>

其中，各属性如下所示。

*  name 指定算法的名字。
 *  class 制定路由算法具体的类名字。
 *  property 为具体算法需要用到的一些属性。

**好了，今天就到这儿吧，我是冰河，我们下期见！！**