更新README文件

This commit is contained in:
lsy
2017-09-10 21:33:19 +08:00
parent e54f9cef87
commit aa496de3ec
+46 -83
View File
@@ -1,83 +1,46 @@
<h1>欢迎查看micro-fast项目说明</h1>
<hr>
<ol>
<li><h2>项目简介</h2>
<p>本项目使用mybatis,spring系列框架作为基础,致力于打造一套中小企业分布式系统解决方案.借助于springCould微服务
框架,对原框架进行整合扩展使用云架构进行开发.</p>
</li>
<li><h2>模块介绍</h2>
<ol>
<li><h3>SSM公共模块 common</h3>
<p>common模块对SSM框架进行了整合,借助springboot实现了模块的热插拔,具有可复用性和可扩展性
</p>
</li>
<li><h3>配置中心 config-server</h3>
<p>配置中心默认启动端口号9999,健康检查端口号19999.访问地址www.config.server.com
</p>
</li>
<li><h3>注册中心 eureka-sever</h3>
<p>注册中心默认启动端口号10002,健康检查端口号20002.访问地址www.eureka.server.com.为保证服务的稳定可靠,
可以创建多个注册中心,实现服务注册的备份冗余,实现高可用性
</p>
</li>
<li><h3>注册中心2 eureka-sever2</h3>
<p>注册中心2默认启动端口号10003,健康检查端口号20003.访问地址www.eureka.server2.com.
</p>
</li>
<li><h3>用户权限管理中心 upms</h3>
<p>用户权限管理中心默认启动端口号10004,健康检查端口号20004.访问地址www.upms.com
</p>
</li>
<li><h3>后台管理界面 manage-system</h3>
<p>使用react.js搭建后台管理界面
</p>
</li>
</ol>
</li>
<li><h2>项目相关约束</h2>
<p>遵循类似于springboot约定大与配置的原则.本项目开发约束如下:
<h3>关于使用docker方式运行项目</h3>
<p>可以使用传统方式运行,可以使用docker
容器的方式运行。程序的启动顺序是配置中心,
注册中心,其他服务。无论是使何种方式运行,
保证除配置中心外,其他所有服务都能从配置中
加载到对应的配置文件,其他所有的服务都能注
册到注册中心。所以运行的时候一定要将除配置
中心外所有服务的注册空间的配置空间都指定正
确,本项目中本地运行时则是都指定到本机的
ip地址</p>
<h3>common模块的相关约束</h3>
<p>得益于springboot的自动配置以及条件化装配的机制.我们可以扩展封装自己的ssm-boot,
也是就是本项目中的commom,本项目的自定义扩展配置如下:
<ul>
<li>
jdbc.username 用户名(必要参数)<br>
jdbc.password 密码是使用common模块中的AESUtil加密过后的(必要参数)<br>
jdbc.url    数据库连接的url(必要参数)<br>
jdbc.driverClass 数据库连接驱动类(必要参数)
</li>
<li>
druid.servletInitParams druid数据连接池的servlet的初始化参数,默认的druid账号
密码是root,studyj2e.如果需要自定义可以传入自己的配置,使用key:value的数组的形式.<br>
druid.servletUrl druid数据库连接池的访问路径,默认访问路径是/druid <br>
druid.beanNames druid要监控的bean的名字,多个使用逗号分割<br> 
druid.defaultAutoCommit 事务是否自动提交,默认为true<br>
druid.initialSize 连接池的初始化大小,默认是20<br>
druid.maxActive 连接池的最大的数量,默认是50<br>
druid.minIdle 连接池的最小空闲数量,默认是10<br>
druid.maxWait 当连接池中连接已经用完了,等待建立一个新连接的最大毫秒数,默认是1000<br>
druid.minEvictableIdleTimeMillis 等待到达多长时间释放连接池,默认是3600000
</li>
<li>
mybatis.typeAliasesPackage pojo包所在的位置(必要参数)<br>
mybatis.mappers mapper映射文件所在的路径(必要参数)<br>
mybatis.pageHelperProperties pagehelper分页插件所在的位置,默认方言是mysql,如果需要自定义可以传入
自己的配置,使用key:value的数组的形式.<br>
除此之外mybatis的dao层扫描的配置需要在项目中自行配置
</li>
</ul>
</p>
</p>
</li>
</ol>
# 欢迎查看micro-fast项目说明
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
## 项目简介
`micro-fast`使用mybatis,spring系列框架作为基础,致力于打造一套中小企业分布式系统解决方案.借助于springCould微服务框架,对原框架进行整合扩展使用
云架构进行开发
## 模块介绍
### SSM公共模块 common
common模块对SSM框架进行了整合,借助springboot实现了模块的热插拔,具有可复用性和可扩展性
### 配置中心 config-server
配置中心默认启动端口号9999,健康检查端口号19999.访问地址www.config.server.com
### 注册中心 eureka-sever
注册中心默认启动端口号10002,健康检查端口号20002.访问地址www.eureka.server.com.为保证服务的稳定可靠,可以创建多个注册中心,实现服务注
册的备份冗余,实现高可用性
### 注册中心2 eureka-sever2
注册中心2默认启动端口号10003,健康检查端口号20003.访问地址www.eureka.server2.com.
### 用户权限管理中心 upms.
用户权限管理中心默认启动端口号10004,健康检查端口号20004.访问地址www.upms.com
### 后台管理界面 manage-system
使用react.js搭建后台管理界面
## 项目相关约束
### 遵循类似于springboot约定大与配置的原则.本项目开发约束如下:
#### 关于使用docker方式运行项目
可以使用传统方式运行,可以使用docker容器的方式运行.程序的启动顺序是配置中心,注册中心,其他服务。无论是使何种方式运行,保证除配置中心外,其
他所有服务都能从配置中加载到对应的配置文件,其他所有的服务都能注册到注册中心。所以运行的时候一定要将除配置中心外所有服务的注册空间的配置空间都指
定正确,本项目中本地运行时则是都指定到本机的ip地址
#### common模块的相关约束
得益于springboot的自动配置以及条件化装配的机制.我们可以扩展封装自己的ssm-boot,也是就是本项目中的commom,本项目的自定义扩展配置如下:
`jdbc.username` 用户名(必要参数)
`jdbc.password` 密码是使用common模块中的AESUtil加密过后的(必要参数)
`jdbc.url`    数据库连接的url(必要参数)
`jdbc.driverClass` 数据库连接驱动类(必要参数)
`druid.servletInitParams` druid数据连接池的servlet的初始化参数,默认的druid账号密码是root,studyj2e.如果需要自定义可以传入自己的配
置,使用key:value的数组的形式.
`druid.servletUrl` druid数据库连接池的访问路径,默认访问路径是/druid
`druid.beanNames ` druid要监控的bean的名字,多个使用逗号分割
`druid.defaultAutoCommit` 事务是否自动提交,默认为true
`druid.initialSize` 连接池的初始化大小,默认是20
`druid.maxActive` 连接池的最大的数量,默认是50
`druid.minIdle`连接池的最小空闲数量,默认是10
`druid.maxWait` 当连接池中连接已经用完了,等待建立一个新连接的最大毫秒数,默认是1000
`druid.minEvictableIdleTimeMillis` 等待到达多长时间释放连接池,默认是3600000
`mybatis.typeAliasesPackage` pojo包所在的位置(必要参数)
`mybatis.mappers` mapper映射文件所在的路径(必要参数)
`mybatis.pageHelperProperties` pagehelper分页插件所在的位置,默认方言是mysql,如果需要自定义可以传入自己的配置,使用key:value的数
组的形式.
除此之外mybatis的dao层扫描的配置需要在项目中自行配置