# com_around_project

**Repository Path**: moodincode/com_around_project

## Basic Information

- **Project Name**: com_around_project
- **Description**: spring cloud springboot 
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2020-01-14
- **Last Updated**: 2025-05-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# com_around_project
 * 说明:本项目涉及的代码不以任何形式收费,可用于商业项目,对于使用本项目过程中,产生的任何问题与风险均和本作者无关.
## spring cloud 分布式系统 

 [推荐 方志朋的博客 史上最简单的 SpringCloud 教程](https://blog.csdn.net/forezp/article/details/70148833)
### 项目如果模块过多,请参考文档或者切换分支进行学习
### 一.启动顺序 一般情况下

1.按端口从小到大启动(有些没有依赖关系的启动顺序可以不按端口大小启动)


### 二.项目约束  此项目约定项目格式如下

1.所有文件夹都以小写字母命名,

2.所有类都以大写字母开头,驼峰命名,

3.所有方法都以小写字母开头,驼峰命名,

4.废弃的方法以@Deprecated注解标识为过时方法,如果有新的方法代替,请使用{@link com.around.xxx#方法名} 注释,方便开发者去查看新接口的方法

5.如有其他代码格式以阿里巴巴代码规约检查

6.所有项目都以com.around为起始目录,接下来的目录以功能或业务命名,比如eureka注册中心,目录为com.around.eureka

7.springboot启动类放在com.around目录下,防止引用组件时,部分依赖springbean的没有被依赖注入,例如com.around.component.fastdfs目录下的bean,

如果启动类在com.around.XXX下,则无法默认扫描到,启动类默认只扫描当前类所在目录以及子目录的文件

8.项目结构命名规则:

注册中心,以register-开头

配置中心,以config-开头

网关中心,以gateway-开头

监控中心,以monitor-开头

生产者,以producer-开头

消费者,以customer-开头

定时器,以scheduler-开头

组件类,以component-开头

8.修改别人的代码或者变更需求,应在相关位置注释号变更时间,变更的需求逻辑等,防止出现bug或者需求不一致时造成不必要的纠纷

9.变量命名避免使用简单的a,b,c,d命名,应该描述变量相关的功能作用等

10.版本提交

版本提交前,先更新一下代码,防止提交冲突,提交注释格式约定:开发业务#涉及功能;
开发业务#涉及的变更内容描述,尽量描述请求变更的功能点或者涉及的需求变更,以便后来开发者查看日志

11. maven依赖管理

1. 所有子模块中需引入父工程pom文件,为了统一版本管理,请在子项目pom最顶部引入,
否则子项目需要手动指定自身版本号而无法继承父工程版本号,引入格式如下

```
 <parent>
    <groupId>com.around</groupId>
    <artifactId>com-around</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <!-- lookup parent from repository -->
</parent>


```
2.为了统一管理与框架升级,所有子项目的引用都需要在父工程的pom管理中定义,子项目无须带版本号引用,父工程中的jar的版本号也统一
在<properties>中管理
3.父工程不要引入maven build插件,否则子项目都继承该插件,导致没有main入口的组件包在编译时报错
组件包也不能引入maven build插件,只有需要编译成jar包的子项目中才加入该插件,否则会编译失败,会出现无法编译xx模块.jar这样的错误
4.有些情况下test类启动报错会导致maven构建失败,请跳过test的build,idea上直接点击maven模块上方闪电图标,激活后便跳过test.
需要编译的子项目引入maven build插件,如下所示
```
<build>
    <plugins>
        <!-- 引用springboot相关maven进行编译,否则编译会缺少清单信息-->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <!--指定为jar,否则打包回缺少主清单 -->
                <layout>JAR</layout>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <!--依赖文件重新打包 -->
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

```


12. 配置文件中需要区分环境.

  通过spring.profiles.active 来切换环境,例如 spring.profiles.active=dev 切换到开发者环境,不同环境中的参数值不一样,比如数据库地址,用户名,密码等
  
  开发环境  application-dev.yml,
  
  测试环境  application-test.yml/application-uat.yml,
  
  生产环境  application-product.yml,

### docker相关命令
[docker相关搭建](http://note.youdao.com/noteshare?id=6000a5e6d0545c841c8586ee9439f697)


  ### 关联README 
## 代码生成工具
[rapid framework代码生成工具](/code-generator-rapid/README.md)
  
## 注册中心
  
[1.eureka注册中心单机版](/register-eureka-server/README.md)

[2.eureka高可用注册中心](/register-multi-eureka-server/README.md)

[3.阿里巴巴nacos注册中心](/register-nacos-server/README.md)

[4 consul注册中心](/register-consul-server/README.md)

[5 zookeeper注册中心](/register-zookeeper-server/README.md)

## 配置中心

[1.配置中心说明文档](/config-server/README.md)

[2.nacos配置中心说明文档](/config-nacos-server/README.md)

## 网关中心
  
 [1.zuul网关中心说明文档](/gateway-zuul/README.md)
 
 [2.sentinel网关中心说明文档](/gateway-sentinel/README.md)
  
 [3.spring gateway网关中心说明文档](/gateway-spring-gateway-server/README.md)
 

## 监控中心

[1.监控中心-zipkin分布式服务链路追踪说明文档](/monitor-zipkin-server/README.md)

[2.监控中心-jaeger分布式调用链路说明文档](/monitor-jaeger-server/README.md)

[3.监控中心-hystrix turbine 断路器集群监控说明文档](/monitor-hystrix-turbine-server/README.md)

[4.springboot admin监控说明文档](/monitor-spring-boot-admin/README.md)

## 生产者

[0.多测试实例端(测试专用) 生产者使用端](/producer-multi-test-server/README.md)

[1.fastDFS分布式文件系统端](/producer-fastdfs-server/README.md)

[2.redis生产者使用端](/producer-redis-server/README.md)

[3.elasticsearch 生产者使用端](/producer-elasticsearch-server/README.md)

[4.solr 生产者使用端](/producer-solr-server/README.md)

[5.mongodb 生产者使用端](/producer-mongodb-server/README.md)

[6.jaeger 生产者使用端](/producer-jaeger-server/README.md)

[7.activeMq 生产者使用端](/producer-activemq-server/README.md)

[8.rabbitMq 生产者使用端](/producer-rabbitmq-server/README.md)

[9.hadoop大数据 生产者使用端](/producer-rabbitmq-server/README.md)

[10.mybatis 生产者使用端](/producer-mybatis-server/README.md)

[11.hibernate 生产者使用端](/producer-hibernate-server/README.md)

[12.mybatis plus 生产者使用端](/producer-mybatisplus-server/README.md)

[13.springboot admin监控 生产者使用端](/producer-spring-boot-admin-server/README.md)

[14.webflux 生产者使用端](/producer-webflux-server/README.md)

[15.spring cache 生产者使用端](/producer-spring-boot-cache-server/README.md)

[16.memcached 生产者使用端](/producer-memcached-server/README.md)

[17.kafka生产者使用端](/producer-kafka-server/README.md)

[18.sharding jdbc 分库分表生产者使用端](/producer-shardingjdbc-server/README.md)

[19.nacos 配置中心 生产者使用端](/producer-nacos-config-server/README.md)

[20.Rsocket 生产者使用端](/producer-rsocket-server/README.md)

[21.websocket 生产者使用端](/producer-websocket-server/README.md)

[22. seata分布式事务 生产者使用端](/producer-seata-server/README.md)

[23. dubbo 生产者使用端](/producer-dubbo-server/README.md)

[24. lcn分布式事务 生产者使用端](/producer-lcn-server/README.md)

[25.1 spring session 分布式session 生产者使用端A](/producer-spring-session-server-a/README.md)
[25.2 spring session 分布式session 生产者使用端B](/producer-spring-session-server-b/README.md)

[26 flowable 工作流生产者使用端](/producer-flowable-server/README.md)


## 消费者

[1.ribbon负载均衡 消费者使用端](/consumer-ribbon-server/README.md)

[2.hystrix断路器和Hystrix Dashboard断路器监控 消费使用端](/consumer-hystrix-server/README.md)

[3.feign 远程调用 消费使用端](/consumer-feign-server/README.md)

[4.freemarker页面模板引擎 消费使用端](/consumer-freemarker-server/README.md)

[5.thymeleaf页面模板引起 消费使用端](/consumer-thymeleaf-server/README.md)

[6.sentinel 消费使用端](/consumer-sentinel-server/README.md)

[7.consul注册中心 消费使用端](/consumer-consul-server/README.md)

[8.zookeeper注册中心 消费使用端](/consumer-zookeeper-server/README.md)

[9.RSocket 消费使用端](/consumer-rsocket-server/README.md)

[10.dubbo 消费使用端](/consumer-dubbo-server/README.md)

## 定时器

[1.quartz 任务调度器](/scheduler-quartz-server/README.md)

[2.elasticJob 任务调度器](/scheduler-elastic-job-lite-server/README.md)

## 组件相关文档

[1.fastDFS分布式文件系统 组件化](/component-fastdfs/README.md)

[2.redis 组件化](/component-redis/README.md)

[3.elasticsearch 组件化](/component-elasticsearch/README.md)

[4.solr 组件化](/component-solr/README.md)

[5.mongodb 组件化](/component-mongodb/README.md)

[6.jaeger 组件化](/component-jaeger/README.md)

[7.activeMq 组件化](/component-activemq/README.md)

[8.rabbitMq 组件化](/component-rabbitmq/README.md)

[9.hadoop大数据 组件化](/component-hadoop/README.md)

[10.mybatis 组件化](/component-mybatis/README.md)

[11.hibernate 组件化](/component-hibernate/README.md)

[12.mybatis plus 组件化](/component-mybatisplus/README.md)

[13.memcached 组件化](/component-memcached/README.md)

[14.kafka 组件化](/component-kafka/README.md)

[15.sharding jdbc 分库分表 组件化](/component-shardingjdbc/README.md)



### maven仓库地址
[maven仓库](https://mvnrepository.com/)


##打赏
* 小白作者,整合一些入门例子,如有不合理的地方,欢迎大家指正.
* 本项目涉及得一些技术参考来于网络,部分参考带有原作者链接,如有遗漏,请及时联系.
* 邮箱地址: menghuanzuqiuxing@163.com
* 不要求用户打赏,如果支持该作者,可以打赏以下账户:

<p style="text-align: center">
<img src="1585721924.jpg" width="350px" height="350px"/>
</p>
<p style="text-align: center">
<img src="mm_facetoface_collect_qrcode_1585721781999.png" width="350px" height="350px"/>
</p>