# mycat

**Repository Path**: longxian435/mycat

## Basic Information

- **Project Name**: mycat
- **Description**: 利用mycat做分表分库，具体实现增加对mysql的吞吐量
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-10-25
- **Last Updated**: 2024-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mycat

#### 介绍
利用mycat做分表分库，具体实现增加对mysql的吞吐量

#### 软件架构
软件架构说明

简单的项目中利用mycat流程图
![输入图片说明](https://images.gitee.com/uploads/images/2019/0723/193438_f811495a_4864477.png "未命名文件.png")
#### 安装教程

- 1.我这里用mycat 1.6.release版本。
- 2.需要jdk1.7及以上版本。（可以是用低版本的，但是mycat的版本相对的需要降低，可以看官网 http://www.mycat.io/）。
- 3.我这里于springboot集成的。
- 4.是在linux服务器搭建的


#### 使用说明

-  ** 1.第一步：下载mycat 1.6.release ** 
- 
** 运行命令：
解压文件
tar -zxvf Mycat-server-1.6-RELEASE-20161028204710-linux.tar.gz
会生成mycat文件夹

-  **2.如果没有安装jdk1.7及以上版本的话，需要安装jdk1.7及以上。** 
- 
这里只显示配置jdk1.7环境。
命令：
vim /etc/profile
export JAVA_HOME=/home/xm6f/dev/jdk1.7.0_80
export JRE_HOME=/home/xm6f/dev/jdk1.7.0_80/jre
export MYCAT_HOME=/home/xm6f/dev/mycat
export PATH=$PATH:$JAVA_HOME/bin:$JRE_HOME/bin:$MYCAT_HOME/bin


-   **3.修改wrapper.conf文件，配置jdk** 
- 
 文件位置在/mycat/config/wrapper.conf
命令 vi /mycat/config/wrapper.conf
修改：
wrapper.java.command=%JAVA_HOME%/bin/java


-  **4.修改schema.xml文件** 
- 
文件位置在/mycat/config/schema.xml
```
<?xml version="1.0"?>
<!DOCTYPE mycat:schema SYSTEM "schema.dtd">
<mycat:schema xmlns:mycat="http://io.mycat/">
	<!-- 
		name  逻辑数据库名，与server.xml中的schema对应
    	checkSQLschema	数据库前缀相关设置，当该值为true时，例如我们执行语句select * from TESTDB.company 。mycat会把语句修改为 select * from company 去掉TESTDB。
		sqlMaxLimit	当该值设置为某个数值时，每条执行的sql语句，如果没有加上limit语句，Mycat会自动加上对应的值。不写的话，默认返回所有的值。
	-->
	<schema name=" **TESTDB** " checkSQLschema="false" sqlMaxLimit="100">
		<!-- random sharding using mod sharind rule -->
		<!--
			name	表名，物理数据库中表名
			dataNode	表存储到哪些节点，多个节点用逗号分隔。节点为下文dataNode设置的name
			primaryKey	主键字段名，自动生成主键时需要设置
			autoIncrement	是否自增
			rule	分片规则名，具体规则下文rule详细介绍
			type 该属性定义了逻辑表的类型，目前逻辑表只有全局表和普通表。全局表： global 普通表：无 
					注：全局表查询任意节点，普通表查询所有节点效率低
			autoIncrement mysql对非自增长主键，使用last_insert_id() 是不会返回结果的，只会返回0.所以，只有定义了自增长主键的表，才可以用last_insert_id()返回主键值。
					mycat提供了自增长主键功能，但是对应的mysql节点上数据表，没有auto_increment,那么在mycat层调用last_insert_id()也是不会返回结果的。
			needAddLimit 指定表是否需要自动的在每个语句后面加上limit限制，由于使用了分库分表，数据量有时候会特别庞大，这时候执行查询语句，
			忘记加上limt就会等好久，所以mycat自动为我们加上了limit 100，这个属性默认为true，可以自己设置为false禁用。如果使用这个功能，最好配合使用数据库模式的全局序列。
			subTables	分表，分表目前不支持Join。
	    -->
		<table name="t_user" primaryKey="id" type="global" dataNode="dn1,dn2" rule="mod-long" />
		
	</schema>
<!--
   name	定义数据节点的名字，这个名字需要唯一。我们在table标签上用这个名字来建立表与分片对应的关系
   dataHost	用于定义该分片属于哪个数据库实例，属性与datahost标签上定义的name对应
   database	用于定义该分片属于数据库实例上的具体库。
-->
	<dataNode name="dn1" dataHost="localhost1" database="mycat1" />
	<dataNode name="dn2" dataHost="localhost1" database="mycat2" />
<!--
	name	唯一标示dataHost标签，供上层使用
	maxCon	指定每个读写实例连接池的最大连接。
	minCon	指定每个读写实例连接池的最小连接，初始化连接池的大小
	balance	负载均称类型
		balance="0"：不开启读写分离机制，所有读操作都发送到当前可用的writeHost上
		balance="1"：全部的readHost与stand by writeHost参与select语句的负载均衡，简单的说，当双主双从模式（M1-S1，M2-S2 并且M1 M2互为主备），正常情况下，M2,S1,S2都参与select语句的负载均衡。
		balance="2"：所有读操作都随机的在writeHost、readHost上分发
		balance="3"：所有读请求随机的分发到writeHst对应的readHost执行，writeHost不负担读写压力。（1.4之后版本有）
	writeType	负载均衡类型。
		writeType="0", 所有写操作发送到配置的第一个 writeHost，第一个挂了切到还生存的第二个writeHost，重新启动后已切换后的为准，切换记录在配置文件中:dnindex.properties .
		writeType="1"，所有写操作都随机的发送到配置的 writeHost。1.5以后版本废弃不推荐。
  	switchType	-1不自动切换
-->
	<dataHost name="localhost1" maxCon="1000" minCon="10" balance="0"
			  writeType="0" dbType="mysql" dbDriver="native" switchType="1"  slaveThreshold="100">
		<heartbeat>select user()</heartbeat>
		<!-- can have multi write hosts -->
		<writeHost host="hostM1" url="物理数据库地址:3306" user="dev"
				   password="dev123">
		</writeHost>
	</dataHost>
</mycat:schema>
```
具体可以参照
https://blog.csdn.net/tornadojava/article/details/54948662


-  **5.修改server.xml文件** 
- 
/mycat/config/server.xml

```
<?xml version="1.0" encoding="UTF-8"?>
<!-- - - 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. -->
<!DOCTYPE mycat:server SYSTEM "server.dtd">
<mycat:server xmlns:mycat="http://io.mycat/">
	<system>
	<property name="useSqlStat">0</property>  <!-- 1为开启实时统计、0为关闭 -->
	<property name="useGlobleTableCheck">0</property>  <!-- 1为开启全加班一致性检测、0为关闭 -->

		<property name="sequnceHandlerType">2</property>
      <!--  <property name="useCompression">1</property>--> <!--1为开启mysql压缩协议-->
        <!--  <property name="fakeMySQLVersion">5.6.20</property>--> <!--设置模拟的MySQL版本号-->
	<!-- <property name="processorBufferChunk">40960</property> -->
	<!-- 
	<property name="processors">1</property> 
	<property name="processorExecutor">32</property> 
	 -->
		<!--默认为type 0: DirectByteBufferPool | type 1 ByteBufferArena-->
		<property name="processorBufferPoolType">0</property>
		<!-- mycat的使用端口 -->
		<property name="serverPort"> **8066** </property> 
		<!-- mycat的管理端口 -->
		<property name="managerPort">9066</property> 
		<!--默认是65535 64K 用于sql解析时最大文本长度 -->
		<!--<property name="maxStringLiteralLength">65535</property>-->
		<!--<property name="sequnceHandlerType">0</property>-->
		<!--<property name="backSocketNoDelay">1</property>-->
		<!--<property name="frontSocketNoDelay">1</property>-->
		<!--<property name="processorExecutor">16</property>-->
		<!--
			<property name="serverPort">8066</property> <property name="managerPort">9066</property> 
			<property name="idleTimeout">300000</property> <property name="bindIp">0.0.0.0</property> 
			<property name="frontWriteQueueSize">4096</property> <property name="processors">32</property> -->
		<!--分布式事务开关，0为不过滤分布式事务，1为过滤分布式事务（如果分布式事务内只涉及全局表，则不过滤），2为不过滤分布式事务,但是记录分布式事务日志-->
		<property name="handleDistributedTransactions">0</property>
		
			<!--
			off heap for merge/order/group/limit      1开启   0关闭
		-->
		<property name="useOffHeapForMerge">1</property>

		<!--
			单位为m
		-->
		<property name="memoryPageSize">1m</property>

		<!--
			单位为k
		-->
		<property name="spillsFileBufferSize">1k</property>

		<property name="useStreamOutput">0</property>

		<!--
			单位为m
		-->
		<property name="systemReserveMemorySize">384m</property>


		<!--是否采用zookeeper协调切换  -->
		<property name="useZKSwitch">true</property>


	</system>
	
	<!-- 全局SQL防火墙设置 -->
	<!-- 
	<firewall> 
	   <whitehost>
	      <host host="127.0.0.1" user="mycat"/>
	      <host host="127.0.0.2" user="mycat"/>
	   </whitehost>
       <blacklist check="false">
       </blacklist>
	</firewall>
	-->
	
	<user name="root">
		<property name="password">123456</property>
		<property name="schemas">TESTDB</property>
	</user>

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

</mycat:server>


```
 **注意：** 

- <property name="schemas"> **TESTDB** </property> 
- 
是跟  schema.xml 文件中的

```
<schema name=" **TESTDB** " checkSQLschema="false" sqlMaxLimit="100">

```
的name属性是一样的。


-  **6.rule.xml (这里有很多规则，分片，分表等规则)** 
- 
```
<?xml version="1.0" encoding="UTF-8"?>
<!-- - - 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. -->
<!DOCTYPE mycat:rule SYSTEM "rule.dtd">
<mycat:rule xmlns:mycat="http://io.mycat/">
	<tableRule name="rule1">
		<rule>
			<columns>id</columns>
			<algorithm>func1</algorithm>
		</rule>
	</tableRule>

	<tableRule name="rule2">
		<rule>
			<columns>user_id</columns>
			<algorithm>func1</algorithm>
		</rule>
	</tableRule>

	<tableRule name="sharding-by-intfile">
		<rule>
			<columns>sharding_id</columns>
			<algorithm>hash-int</algorithm>
		</rule>
	</tableRule>
	<tableRule name="auto-sharding-long">
		<rule>
			<columns>id</columns>
			<algorithm>rang-long</algorithm>
		</rule>
	</tableRule>
	

> <tableRule name="mod-long">
> 		<rule>
> 			<columns>id</columns>
> 			<algorithm>mod-long</algorithm>
> 		</rule>
> 	</tableRule>
	<tableRule name="sharding-by-murmur">
		<rule>
			<columns>id</columns>
			<algorithm>murmur</algorithm>
		</rule>
	</tableRule>
	<tableRule name="crc32slot">
		<rule>
			<columns>id</columns>
			<algorithm>crc32slot</algorithm>
		</rule>
	</tableRule>
	<tableRule name="sharding-by-month">
		<rule>
			<columns>create_time</columns>
			<algorithm>partbymonth</algorithm>
		</rule>
	</tableRule>
	<tableRule name="latest-month-calldate">
		<rule>
			<columns>calldate</columns>
			<algorithm>latestMonth</algorithm>
		</rule>
	</tableRule>
	
	<tableRule name="auto-sharding-rang-mod">
		<rule>
			<columns>id</columns>
			<algorithm>rang-mod</algorithm>
		</rule>
	</tableRule>
	
	<tableRule name="jch">
		<rule>
			<columns>id</columns>
			<algorithm>jump-consistent-hash</algorithm>
		</rule>
	</tableRule>

	<function name="murmur"
		class="io.mycat.route.function.PartitionByMurmurHash">
		<property name="seed">0</property><!-- 默认是0 -->
		<property name="count">2</property><!-- 要分片的数据库节点数量，必须指定，否则没法分片 -->
		<property name="virtualBucketTimes">160</property><!-- 一个实际的数据库节点被映射为这么多虚拟节点，默认是160倍，也就是虚拟节点数是物理节点数的160倍 -->
		<!-- <property name="weightMapFile">weightMapFile</property> 节点的权重，没有指定权重的节点默认是1。以properties文件的格式填写，以从0开始到count-1的整数值也就是节点索引为key，以节点权重值为值。所有权重值必须是正整数，否则以1代替 -->
		<!-- <property name="bucketMapPath">/etc/mycat/bucketMapPath</property> 
			用于测试时观察各物理节点与虚拟节点的分布情况，如果指定了这个属性，会把虚拟节点的murmur hash值与物理节点的映射按行输出到这个文件，没有默认值，如果不指定，就不会输出任何东西 -->
	</function>

	<function name="crc32slot"
			  class="io.mycat.route.function.PartitionByCRC32PreSlot">
		<property name="count">2</property><!-- 要分片的数据库节点数量，必须指定，否则没法分片 -->
	</function>
	<function name="hash-int"
		class="io.mycat.route.function.PartitionByFileMap">
		<property name="mapFile">partition-hash-int.txt</property>
	</function>
	<function name="rang-long"
		class="io.mycat.route.function.AutoPartitionByLong">
		<property name="mapFile">autopartition-long.txt</property>
	</function>
	

> <function name="mod-long" class="io.mycat.route.function.PartitionByMod">
> 		<!-- how many data nodes -->
> 		<property name="count">2</property>
> 	</function>

	<function name="func1" class="io.mycat.route.function.PartitionByLong">
		<property name="partitionCount">8</property>
		<property name="partitionLength">128</property>
	</function>
	<function name="latestMonth"
		class="io.mycat.route.function.LatestMonthPartion">
		<property name="splitOneDay">24</property>
	</function>
	<function name="partbymonth"
		class="io.mycat.route.function.PartitionByMonth">
		<property name="dateFormat">yyyy-MM-dd</property>
		<property name="sBeginDate">2015-01-01</property>
	</function>
	
	<function name="rang-mod" class="io.mycat.route.function.PartitionByRangeMod">
        	<property name="mapFile">partition-range-mod.txt</property>
	</function>
	
	<function name="jump-consistent-hash" class="io.mycat.route.function.PartitionByJumpConsistentHash">
		<property name="totalBuckets">3</property>
	</function>
</mycat:rule>
```
 **注意特殊位置的** 
 **我这里用的是mod-long 及 取模算法
** <tableRule name="mod-long">
> 		<rule>
                        对应这个字段进行分库分表，通过这个字段值进行取模
> 			<columns>id</columns>
> 			<algorithm>mod-long</algorithm>
> 		</rule>
> 	</tableRule>

分配到那几个节点上，按照需设置。
> <function name="mod-long" class="io.mycat.route.function.PartitionByMod">
> 		<!-- how many data nodes -->
> 		<property name="count">2</property>
> 	</function>

其他暂时不用配置了。

这样mycat服务就搭建好了。
最后友情提醒，将相关端口需要开放比如我配置8066，当然也可以将服务器防火墙关掉。

 **_

### 现在来整合springboot

_** 

-  **1.配置application.yml** 
- 
```
spring:
  datasource:
    url: jdbc:mysql://mycat部署物理地址: **8066** /TESTDB?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
```
 **注意：
** 加粗的端口号（ **8066** ），是在/mycat/config/server.xml中配置的，相关可以看上面
数据库名称（ **TESTDB** ），是在文件位置在/mycat/config/schema.xml中配置的，相关可以看上面
到这里，整合全部完成。

 **_

### 结束语：

_** 

- 1.mycat使用相当简单，是一款很出色的mysql的中间件，实际开发中还需要做一些处理，不然其性能可以不会很高。这是其原理决定的。
- 2.mycat做到了对业务代码完全解耦，比sharding-jdk这方面相对好很多（至少要在配置文件中配置分片等规则）。
- 3.相比较sharding-jdbc对于多表分片友好很多，不需要修改表结构。

#### 参考文章
https://blog.csdn.net/tornadojava/article/details/54948662
https://blog.csdn.net/qq_37936542/article/details/78613845