新建微服务工程 · SpringBlade开发手册

## 模块介绍框架的模块结构如下： ``` SpringBlade ├── blade-auth -- 授权服务提供 ├── blade-common -- 常用工具封装包 ├── blade-gateway -- Spring Cloud 网关 ├── blade-ops -- 运维中心 ├ ├── blade-admin -- spring-cloud后台管理 ├ └── blade-develop -- 代码生成 ├── blade-service -- 业务模块 ├ ├── blade-desk -- 工作台模块 ├ ├── blade-log -- 日志模块 ├ ├── blade-system -- 系统模块 ├ └── blade-user -- 用户模块 ├── blade-service-api -- 业务模块api封装 ├ ├── blade-desk-api -- 工作台api ├ ├── blade-dict-api -- 字典api ├ ├── blade-system-api -- 系统api └── └── blade-user-api -- 用户api ``` 日常开发中，我们用的最多的模块则是`blade-service`以及` blade-service-api`. * ` blade-service`主要编写业务模块 * ` blade-service-api`主要为其他业务模块提供本模块的api 那么目的很明确了，要开发一个业务模块，我们就需要到`blade-service`以及` blade-service-api`中新建相关的代码啦！下面我们就开始重要的第一步：子工程的新建 ## 新建子工程 1. 在`blade-service`上右击依次选则 `New -> Module` ![](https://box.kancloud.cn/66b71feaeda565193cafa1a7be3e4e9e_871x448.png) 2. 在`New Module`界面选中左侧的`Maven`并且点击`Next` ![](https://box.kancloud.cn/d743961e491757a8283523e4c1049e97_743x598.png) 3. 接着我们可以给`ArtifactId`起个名，这里使用了`blade-demo`(大家可以根据实际的业务模块命名) ![](https://box.kancloud.cn/c50157f196ea121989206747a91fe046_743x598.png) 4. 下一步推荐`Module name`命名的和`ArtifactId`一致 ![](https://box.kancloud.cn/ff010ee646e3cce5901ffe9dd1a3613b_743x598.png) 5. 点击`Finish`等待maven工程加载完毕 6. 我们以同样的方式在`blade-service-api`下新建`blade-demo-api`工程 ![](https://box.kancloud.cn/94c594087c093c89367cdcf3cf6c26e6_355x359.png) ## 工程版本依赖设置 1. 打开`blade-demo-api`工程下的`pom.xml`设置基本信息加上红框内的信息 ![](https://box.kancloud.cn/282bcc6fd8d030e2d3e3addc6f99df54_642x399.png) 2. 打开`blade-demo`工程下的`pom.xml`设置基本信息加上红框内的信息 ![](https://box.kancloud.cn/a70f0564f35c7cfec898a92e9ea2e68c_607x618.png) 3. 以下依赖为刚刚新建的`blade-demo-api`工程，代码组成主要是entity，vo，dto，feign等模块 ~~~ <dependency> <groupId>org.springblade</groupId> <artifactId>blade-demo-api</artifactId> <version>${blade.project.version}</version> </dependency> ~~~ 4. 以下依赖为[Blade-Tool](https://github.com/chillzhuang/blade-tool.git)封装的模块启动依赖，只需引入一个，便解决了所有常用的配置 ~~~ <dependency> <groupId>org.springblade</groupId> <artifactId>blade-core-boot</artifactId> <version>${blade.tool.version}</version> </dependency> ~~~ 5. **商业版采用了bom架构，将所有固定的版本统一管理，自动依赖，无需再配置bladex-tool内的版本，具体引用如下** ~~~ <dependency> <groupId>org.springblade</groupId> <artifactId>blade-core-boot</artifactId> </dependency> ~~~ ## 工程配置 1. 参考`blade-desk`模块，将`resource`下的文件拷贝到`blade-demo`的`resources`文件夹下 ![](https://box.kancloud.cn/2f2c23839af214f6444ac2980405b382_449x466.png) 2. 修改下`application-dev.yml`下`server.port`的值为9101(可以定义为其他端口，但必须不冲突) ![](https://box.kancloud.cn/aa817aeac2b80806815bc18c0c6fd2b5_1031x369.png) 3. 在`blade-demo`的`java`包下新建`package` ![](https://box.kancloud.cn/5442a98aa45e834695e4ab86bfccc103_825x407.png) 4. 推荐命名为`org.springblade.demo` ![](https://box.kancloud.cn/82a62d018f80e316172a7a7710f28743_453x145.png) 5. 参考`blade-desk`模块，将`DeskApplication`拷贝至刚新建的包下并重命名为`DemoApplication` ![](https://box.kancloud.cn/47a674fc1c72e28eb714c4b7e4a13d62_396x556.png) 6. 修改对应代码(后续会详细介绍) ![](https://box.kancloud.cn/da3103481bf7112067c083f12661ff58_749x347.png) 7. 为了让代码更加优雅，我们可以到`blade-common`模块的`CommonConstant`下新建常量 ![](https://box.kancloud.cn/2dbfdcab98b69b79a1a2f0d4cff794b4_735x327.png) 8. 再次修改`DemoApplication` ![](https://box.kancloud.cn/808c7ce63ff4dd3aa264cb4e7e0e88e1_865x281.png) 9. 右击`DemoApplication`启动，查看服务是否注册到了`Nacos`. 10. 我们先启动Demo服务，并访问 http://localhost:8848/nacos 查看效果 11. 如果我们看到blade-demo在注册列表中，说明一个新的微服务已经诞生！