houyi平台-开发指南-开发说明

简介

  • 微服务描述了一种将软件应用程序设计为可独立部署的服务套件的特定方式。通常一个独立的功能就能部署为一个微服务,一组微服务可以部署在一台物理节点上,多台微服务构成的物理节点构成一个微服务集群。

环境搭建


建立一个新项目

  • 开发注意事项
    微服务是一个集群,开发时应该注意有状态的业务处理,在需要使用同步锁的地方考虑使用分布式同步锁。

  • 平台提供的通用组件
    数据库:db-spring-boot-starter项目工程
    日志:log-spring-boot-starter项目工程
    Redis:redis-spring-boot-starter项目工程
    接口文档生成工具:swagger2-spring-boot-starter工程

  • 项目目录说明
    在微服务开发过程中推荐使用以下目录结构:
    config:建议放置配置内容
    controller:微服务的控制器类目录
    service:微服务的Service类目录
    mapper:数据库操作类的目录
    model:数据模型目录

  • 建立新项目
    (1)新建项目

新建一个Spring maven项目放置在business目录下,开发方式基本上同普通的spring项目一致,特别要注意的是这是一个分布式项目,在分布式事物处理上要特别注意。
添加平台提供的依赖项目

(2)复制Demo项目

可以通过复制提供的demo项目,放置在business目录下,快速的开始一个新项目,记得更改项目的artifactId等

Nacos开发配置
命名空间配置说明

项目中使用命名空间区分开发环境,可以通过以下配置来实现:

spring.cloud.nacos.config.namespace=b3404bc0-d7dc-4855-b519-570ed34b62d7
spring.cloud.nacos.discovery.namespace=b3404bc0-d7dc-4855-b519-570ed34b62d7

该配置必须放在 bootstrap.properties 文件中。此外 spring.cloud.nacos.config.namespace 的值是 namespace 对应的 id,id 值可以在 Nacos 的控制台获取。并且在添加配置时注意不要选择其他的 namespace,否则将会导致读取不到正确的配置。

命名空间配置规则
  • 各个环境的命名空间命名规则: ProjectName_ns_XXX
  1. 开发环境:每个开发者在Nacos上建立自己以工号为后缀的命名空间,例如:hx_open_ns_ab002001。开发的时候使用自己的命名空间进行开发调试
  2. dat,uat,vir 环境:后缀名为dat,uat,vir.例如hx_open_ns_dat,hx_open_ns_uat,hx_open_ns_vir
  3. 生产环境:使用后缀名为pro. 例如hx_open_ns_pro
Group和DataID配置规则

不同命名空间下可以有相同的Group和DataID。因此项目中我们使用命名空间区分不同的环境,从而可以共享部分配置。

  • Group命名规则:
    Group统一命名为:ProjectName_group_XXX
    例如:hx_open_group_medium
    环境特殊配置命名为:ProjectName_group_ENV_XXX
    例如:hx_open_group_dat_test

  • DataID命名规则:
    DataID统一命名为:ProjectName_dataid_XXX
    例如:hx_open_dataid_initcfg
    环境特殊配置命名为:ProjectName_dataid_ENV_XXX
    例如:hx_open_dataid_dat_test

Actuator Endpoints

引入包之后,项目自动就支持Actuator,不需要配置。

TODO:后续监控显示模块的对接

开发规范

maven规范

  • 除了根工程的pom.xml之外,子工程的pom.xml引入的jar都不予许设置version属性

  • 新增加jar包依赖的步骤如下

    1. 先查看父工程/根工程是否已引入该jar
    2. 查看根工程的dependencyManagement是否已经有该jar的管理
    3. 如果没有则查看以下地址的Appendix A. Dependency versions 是否有该jar的管理

https://docs.spring.io/platform/docs/Cairo-SR3/reference/htmlsingle/

4. 都没有的话则自己添加该jar的管理,先去根工程的properties里添加版本号,再去dependencyManagement里添加该jar

接口规范

  • 按照restful接口设计规范
    GET (SELECT):从服务器检索特定资源,或资源列表。
    POST (CREATE):在服务器上创建一个新的资源。
    PUT (UPDATE):更新服务器上的资源,提供整个资源。
    PATCH (UPDATE):更新服务器上的资源,仅提供更改的属性。
    DELETE (DELETE):从服务器删除资源。
  • 接口尽量使用名词,禁止使用动词,下面是一些例子
  GET /zoos:列出所有动物园
  POST /zoos:新建一个动物园
  GET /zoos/{id}:获取某个指定动物园的信息
  PUT /zoos/{id}:更新某个指定动物园的信息(提供该动物园的全部信息)
  PATCH /zoos/{id}:更新某个指定动物园的信息(提供该动物园的部分信息)
  DELETE /zoos/{id}:删除某个动物园
  GET /zoos/{id}/animals:列出某个指定动物园的所有动物
  DELETE /zoos/{zId}/animals/{aId}:删除某个指定动物园的指定动物
  • 反例:
  /getAllCars
  /createNewCar
  /deleteAllRedCars

后端返回JSON

  • 后端统一返回 com.hxhealth.common.model.Result 对象
    • datas:具体响应的其他信息
    • resp_code:响应码,目前0是成功、1是失败
    • resp_msg:响应消息
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,475评论 4 372
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,744评论 2 307
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,101评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,732评论 0 221
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,141评论 3 297
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,049评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,188评论 2 320
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,965评论 0 213
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,716评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,867评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,341评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,663评论 3 263
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,376评论 3 244
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,200评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,990评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,179评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,979评论 2 279

推荐阅读更多精彩内容

  • 微服务架构模式的核心在于如何识别服务的边界,设计出合理的微服务。但如果要将微服务架构运用到生产项目上,并且能够发挥...
    java菜阅读 2,913评论 0 6
  • 背景 随着公司业务量的飞速发展,平台面临的挑战已经远远大于业务,需求量不断增加,技术人员数量增加,面临的复杂度也大...
    java菜阅读 617评论 0 0
  • 在拉萨的第90天,不好也不坏,就算坏也不是最坏。一直想要写点东西,却总是懒惰大于激情,做一半的时候就总想着放弃,...
    莫莫莫呀阅读 410评论 0 1
  • 最近在读一念之转这本书,觉得里面的方法特别的好,记下来与大家共勉,四句话改变你的人生 第一步:写下你的批评。 注意...
    厦门奕宁奕恺妈阅读 280评论 0 0
  • 今晚 是提一壶烫热的往事 和一颗熟透的月亮 去拜访你的 我当然知道 你也摆好了一帘清风 和一院秋香 来迎接我和那...
    楷体人生草体梦阅读 594评论 19 19