Skip to content

Commit

Permalink
update: 更新 wk-wiki 开发文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Wizzercn committed Apr 15, 2018
1 parent d5d47fc commit 90be00b
Show file tree
Hide file tree
Showing 41 changed files with 323 additions and 758 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ nutz.dao.interceptor.cache.table.names=sys_user,sys_menu,sys_role
dubbo.registry.address=zookeeper://127.0.0.1:2181
dubbo.protocol.name=dubbo
#dubbo.protocol.port 若端口不指定则为随机端口
dubbo.annotation.package=cn.wizzer.app
dubbo.scan.basePackages=cn.wizzer.app
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ apitoken.appkey=257221db3f2741e598b6e1262f3ec882
dubbo.registry.address=zookeeper://127.0.0.1:2181
dubbo.protocol.name=dubbo
#dubbo.protocol.port 若端口不指定则为随机端口
dubbo.annotation.package=cn.wizzer.app
dubbo.annotation.package=cn.wizzer
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ apitoken.appkey=257221db3f2741e598b6e1262f3ec882
dubbo.registry.address=zookeeper://127.0.0.1:2181
dubbo.protocol.name=dubbo
#dubbo.protocol.port 若端口不指定则为随机端口
dubbo.annotation.package=cn.wizzer.app
dubbo.annotation.package=cn.wizzer
25 changes: 17 additions & 8 deletions wk-wiki/01.QuickStart/01.01.Environment.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,36 @@
## 运行环境
## 运行环境`必须`

* JDK 1.8 以上
* JDK 1.8.x 以上

* Maven 3.5.x 以上

* Tomcat 8.5.x 以上或 Jetty 9.3.x 以上
* Redis 3.2.x 以上

* MySQL 5.5 以上或 Oracle 、SqlServer 等数据库
* Zookeeper 3.4.x 以上

* MySQL 5.6 以上或 Oracle 、SqlServer 等数据库

## IDEA构建

IDEA --> File --> Open ,选择项目所在文件件夹,是“打开项目”,而非导入项目!!是“打开项目”,而非导入项目!!是“打开项目”,而非导入项目!!
* 系统环境变量配好JDK_HOME、MAVEN_HOME,注意你的Maven配置,看这里的[特别提醒](http://nutzam.com/core/basic/maven.html)

* IDEA --> File --> Open ,选择项目所在文件件夹,是“Open项目”,而非导入项目!!是“Open项目”,而非导入项目!!是“Open项目”,而非导入项目!!

* IDEA 打开项目后会自动下载jar包构建项目,等待构建完成


## IDEA配置

File > Settings > File Encodings > All UTF-8

![IDEA编码设置](../images/01.png)

## IDEA插件安装`可选`
## 安装代码生成器插件`可选`

File > Plugins > Install plugin from disk

File > Plugins > Install plugin from disk
代码生成器的使用后面章节会介绍

选择代码生成器插件 wk-code-ideaplugin.jar 进行安装,安装成功后会提示重启IDEA,请重启IDEA
选择代码生成器插件 wk-code-ideaplugin-nb.jar 进行安装,安装成功后会提示重启IDEA,请重启IDEA

![IDEA插件截图](../images/02.png)
205 changes: 0 additions & 205 deletions wk-wiki/01.QuickStart/01.02.DBConfig.md

This file was deleted.

39 changes: 39 additions & 0 deletions wk-wiki/01.QuickStart/01.02.Start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## IDEA配置启动

* 项目根目录执行: mvn install

* IDEA --> Run --> Edit Configurations

![run01](../images/03.png)

* 绿色 + 按钮,选择 Application

![run01](../images/04.png)


* 先选择模块 module,然后选择 Main class 入口类,-Dnutz.profiles.active=prod 运行参数可以让项目加载 application-prod.properties 配置文件

![run01](../images/05.png)

* 根据顺序依次启动 wk-nb-service-sys --> 其他模块 --> wk-nb-web-platform

## 模块说明

| 名称 | 介绍 |
| ---------------------------------------- | ---------------------------------------- |
|[wk-framework](wk-framework) |一些基类及公共方法的封装|
|[wk-model](wk-app/wk-model) |POJO类|
|[wk-common](wk-app/wk-common) |接口类|
|[wk-nb-service-sys](wk-app/wk-nb-service-sys) |系统管理模块,dubbo服务端,NB项目,权限体系|
|[wk-nb-service-cms](wk-app/wk-nb-service-cms) |CMS管理模块,dubbo服务端,NB项目,ig及wkcache演示|
|[wk-nb-service-wx](wk-app/wk-nb-service-wx) |微信管理模块,dubbo服务端,NB项目,微信及微信支付功能演示|
|[wk-nb-task](wk-app/wk-nb-task) |定时任务模块,dubbo服务端,NB项目,支持quartz集群|
|[wk-nb-web-api](wk-app/wk-nb-web-api) |API JWT Token示例,dubbo消费端,NB项目,Mvc|
|[wk-nb-web-platform](wk-app/wk-nb-web-platform) |WEB管理后台模块,dubbo消费端,NB项目,Mvc|

*   确保 MySql、Redis、Zookeeper 默认配置并已启动好
*   MySql 创建名为 nutzwk_nb 的空数据库,在每个NB项目启动时会自动建表,同时初始化数据
*   IDEA 找到每个NB项目下的 ***MainLauncher 类运行,或编译成jar包直接运行
*   wk-nb-service-sys为第一启动项目,然后启动其他NB项目,最后启动wk-nb-web-platform
*   运行参数 -Dnutz.profiles.active=prod 可让NB项目加载 application-prod.properties 配置文件
*   正常启动后访问 http://127.0.0.1:8080/sysadmin 用户名 superadmin 密码 1
8 changes: 8 additions & 0 deletions wk-wiki/01.QuickStart/01.03.Config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## 配置文件说明

* 每个NB项目应该只存在一个配置文件,所有的配置项应该写在这一个 application.properties 文件里

* NB服务端 dubbo端口应该配置为随机的,因为每个NB服务端都应该可以同时启动多个实例实现负载均衡

* NB服务端应该只连单个数据库,不应该出现多数据源的情况(虽然框架支持)

32 changes: 0 additions & 32 deletions wk-wiki/01.QuickStart/01.03.Start.md

This file was deleted.

Loading

0 comments on commit 90be00b

Please sign in to comment.