doc: 编写文档

Author: Mrwen

README.md

@@ -47,25 +47,25 @@ spring-boot-demo
 
 **示例代码与概述**
 
-- [spring-boot-elasticsearch](https://github.com/WENZIZZHENG/spring-boot-demo/tree/master/spring-boot-elasticsearch)
+- [spring-boot-elasticsearch](spring-boot-elasticsearch/README.md)
 
 1.  elasticsearch 6.x，7.x版本示例
 2.  原生elasticsearch操作
 3.  Spring Data ElasticSearch操作示例,ORM操作，聚合操作
 
-- [spring-boot-mybatis-plus示例](https://github.com/WENZIZZHENG/spring-boot-demo/tree/master/spring-boot-mybatis-plus)
+- [spring-boot-mybatis-plus示例](spring-boot-mybatis-plus/README.md)
 
 1.  mybatis-plus 快速入门
 2.  mybatis-plus 代码生成器，自定义模板
 3.  mybatis-plus 多租户，自动分页，乐观锁，防止全表更新与删除，动态表名，sql性能规范，自定义ID生成器，数据填充，枚举等
 4.  mybatis-plus 多数据源
 
-- [spring-boot-sharding-jdbc示例](https://github.com/WENZIZZHENG/spring-boot-demo/tree/master/spring-boot-sharding-jdbc)
+- [spring-boot-sharding-jdbc示例](spring-boot-sharding-jdbc/README.md)
 
 1.  分库分表快速入门（4.1.1版本以及5.0.0版本）
 2.  自定义分库分表规则，自定义自增主键
 3.  与mybatis-plus整合，解决更新时触发分片规则报错问题
 4.  spring-boot-starter-jooq整合sharding-jdbc常见问题及解决方案
 
-* [spring-boot-swagger示例](https://github.com/WENZIZZHENG/spring-boot-demo/tree/master/spring-boot-swagger)
+* [spring-boot-swagger示例](spring-boot-swagger/README.md)
 

spring-boot-elasticsearch/README.md

@@ -4,7 +4,7 @@
 
 ### 1.1 版本选择
 
-[参考地址](https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/#preface.versions)
+参考地址：https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/#preface.versions
 
 |                  Spring Data Release Train                   |                  Spring Data Elasticsearch                   | Elasticsearch |                       Spring Framework                       |                         Spring Boot                          |
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :-----------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
@@ -31,11 +31,11 @@
 
 ### 1.2 中文分词
 
-[elasticsearch-analysis-ik](https://github.com/medcl/elasticsearch-analysis-ik)
+elasticsearch-analysis-ik：https://github.com/medcl/elasticsearch-analysis-ik
 
 
 
 ### 1.3 Mysql数据同步
 
-[alibaba](https://github.com/alibaba)/**[canal](https://github.com/alibaba/canal)**
+[alibaba](https://github.com/alibaba)/canal：https://github.com/alibaba/canal
 

spring-boot-mq-rocketmq/README.md

@@ -0,0 +1,45 @@
+# RocketMQ
+
+## 1 如何保障消息可靠生产(消息100%投递成功)
+
+官网描述，参考最佳实践：https://github.com/apache/rocketmq/blob/master/docs/cn/best_practice.md
+
+#### 3 日志的打印
+
+消息发送成功或者失败要打印消息日志，务必要打印SendResult和key字段。**send消息方法只要不抛异常，就代表发送成功**。发送成功会有多个状态，在sendResult里定义。以下对每个状态进行说明：
+
+- **SEND_OK**
+
+消息发送成功。要注意的是消息发送成功也不意味着它是可靠的。要确保不会丢失任何消息，还应启用**同步Master服务器或同步刷盘，即SYNC_MASTER或SYNC_FLUSH。**
+
+- **FLUSH_DISK_TIMEOUT**
+
+消息发送成功但是服务器刷盘超时。此时消息已经进入服务器队列（内存），只有服务器宕机，消息才会丢失。消息存储配置参数中可以设置刷盘方式和同步刷盘时间长度，如果Broker服务器设置了刷盘方式为同步刷盘，即FlushDiskType=SYNC_FLUSH（默认为异步刷盘方式），当Broker服务器未在同步刷盘时间内（默认为5s）完成刷盘，则将返回该状态——刷盘超时。
+
+- **FLUSH_SLAVE_TIMEOUT**
+
+消息发送成功，但是服务器同步到Slave时超时。此时消息已经进入服务器队列，只有服务器宕机，消息才会丢失。如果Broker服务器的角色是同步Master，即SYNC_MASTER（默认是异步Master即ASYNC_MASTER），并且从Broker服务器未在同步刷盘时间（默认为5秒）内完成与主服务器的同步，则将返回该状态——数据同步到Slave服务器超时。
+
+- **SLAVE_NOT_AVAILABLE**
+
+消息发送成功，但是此时Slave不可用。如果Broker服务器的角色是同步Master，即SYNC_MASTER（默认是异步Master服务器即ASYNC_MASTER），但没有配置slave Broker服务器，则将返回该状态——无Slave服务器可用。
+
+**小结：**
+
+**只要sendResult为SEND_OK状态，且同步Master服务器或同步刷盘，就可确认成功。**
+
+
+
+## 2 消息可靠消费
+
+相对RabbitMQ，RocketMQ的可靠消费并不需要我们做过多的处理。会自动把消费失败的消息扔到死信队列中。只需要做好消息预警即可。
+
+[Consumer示例](spring-boot-rocketmq/rocketmq-consumer/src/main/java/com/example/service/ConsumerCluster.java)
+
+
+
+
+
+## 3: 参考资料
+
+官方中文文档：https://github.com/apache/rocketmq/tree/master/docs/cn

spring-boot-mybatis-plus/README.md

@@ -12,8 +12,8 @@
 
 Mybatis-Plus官网相关文档已经很完善，有问题强烈建议阅读官方文档
 
-1. [Mybatis-Plus官网文档](https://mp.baomidou.com/)
-2. [代码生成器](https://mp.baomidou.com/guide/generator-new.html)
-3. [多数据源dynamic-datasource项目](https://github.com/baomidou/dynamic-datasource-spring-boot-starter)
-4. [多数据源dynamic-datasource详细文档](https://www.kancloud.cn/tracy5546/dynamic-datasource/2264611)
+1. [Mybatis-Plus官网文档]：https://mp.baomidou.com/
+2. [代码生成器]：https://mp.baomidou.com/guide/generator-new.html
+3. [多数据源dynamic-datasource项目]：https://github.com/baomidou/dynamic-datasource-spring-boot-starter
+4. [多数据源dynamic-datasource详细文档]：https://www.kancloud.cn/tracy5546/dynamic-datasource/2264611
 

spring-boot-sharding-jdbc/README.md

@@ -14,12 +14,12 @@
 
 
 
-详情参考： [官网](https://shardingsphere.apache.org/index_zh.html)
+详情参考： [官网]：https://shardingsphere.apache.org/index_zh.html
 
 ## 2 注意事项
 
 1.  版本问题：Sharding-JDBC不同版本之间配置文件差异很大，请确定好自身需要的版本
-2.  常见的问题，[详情参考官网FAQ](https://shardingsphere.apache.org/document/5.0.0/cn/reference/faq/)
+2.  常见的问题，[详情参考官网FAQ]：https://shardingsphere.apache.org/document/5.0.0/cn/reference/faq/
 
 
 
@@ -38,7 +38,7 @@
 2:使用mybatis-plus的雪花算法 可以设为IdType.ASSIGN_ID,只有当插入对象ID 为空，才自动填充，在某些场景下可以自定义id。
 ```
 
-**[雪花算法ID到前端之后精度丢失问题，全局解决方案](https://github.com/WENZIZZHENG/spring-boot-demo/blob/master/spring-boot-sharding-jdbc/spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/JacksonConfig.java)**
+**[雪花算法ID到前端之后精度丢失问题，全局解决方案](spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/JacksonConfig.java)**
 
 #### **3.1.2 redis自增主键**
 
@@ -51,16 +51,16 @@ Service Provider Interface (SPI) 是一种为了被第三方实现或扩展的 A
 与分布式主键 KeyGenerateAlgorithm 接口相同，其他 ShardingSphere 的扩展功能也需要用相同的方式注入才能生效。
 ```
 
-[4.1.1版本参考](https://github.com/WENZIZZHENG/spring-boot-demo/blob/master/spring-boot-sharding-jdbc/spring-boot-sharding-jdbc-4.1.1/sharding-jdbc-4.1.1-db-table/src/main/java/com/example/config/sharding/key/ShardingTableKeyGenerator.java)
+[4.1.1版本参考](spring-boot-sharding-jdbc-4.1.1/sharding-jdbc-4.1.1-db-table/src/main/java/com/example/config/sharding/key/ShardingTableKeyGenerator.java)
 
-[5.0.0版本参考](https://github.com/WENZIZZHENG/spring-boot-demo/blob/master/spring-boot-sharding-jdbc/spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/sharding/key/ShardingTableKeyGenerator.java)
+[5.0.0版本参考](spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/sharding/key/ShardingTableKeyGenerator.java)
 
 
 
 ### **3.2 mybatis-plus更新时，触发分片字段怎么办**
 
 方案一: mybatis-plus更新前，把分片字段设为null。默认null时会跳过set。
-方案二: 使用自定义[mybatis拦截器](https://github.com/WENZIZZHENG/spring-boot-demo/blob/master/spring-boot-sharding-jdbc/spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/MybatisPluginCustomInterceptor.java)，在拦截器中把分片字段set为空即可。（注意，mybatis-plus自动填功在这里是不能解决这个问题的）
+方案二: 使用自定义[mybatis拦截器](spring-boot-sharding-jdbc-5.0.0/sharding-jdbc-5.0.0-db-table/src/main/java/com/example/config/MybatisPluginCustomInterceptor.java)，在拦截器中把分片字段set为空即可。（注意，mybatis-plus自动填功在这里是不能解决这个问题的）
 
 
 
@@ -97,7 +97,7 @@ public class JooqDao {
 
 SQL示例：delete t0 from order_item t0 where t0.order_id = ?
 
-[sharding-jdbc 中的issues](https://github.com/apache/shardingsphere/issues/13273)
+[sharding-jdbc 中的issues]：https://github.com/apache/shardingsphere/issues/13273
 
 解决方案，直接使用**5.0.0**以上版本
 
@@ -165,7 +165,7 @@ guava版本冲突
 
 ## **4 其它参考**
 
-1. [4.0.0-RC1版本Demo参考](https://github.com/yinjihuan/sharding-jdbc)
+1. [4.0.0-RC1版本Demo参考]：https://github.com/yinjihuan/sharding-jdbc
 
 ## 5 待补充
 

spring-boot-swagger/README.md

@@ -34,5 +34,5 @@
 
 项目更多Demo
 
-[swagger-bootstrap-ui-demo](https://gitee.com/xiaoym/swagger-bootstrap-ui-demo)
+[swagger-bootstrap-ui-demo]：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo