Hzero目的是沉淀大量通用标准组件、服务,目标是搭建各种产品快速组件、开发的融合平台,减少成本浪费。
Hzero代码体系
- 代码架构
- hzero-parent 同一管理所有组件、服务版本
- hzero-starter 基础通用组件(源码开发)
- choerodon-starter 猪齿鱼基础组件(开源)
- hzero-boot 客户端组件
- hzero-plugin 服务插件
- hzero-service 服务(可依赖包)
- hzero-resource 建表脚本及初期数据
- hzero-front 前端工程
Hzero基础服务架构
- hzero基础服务
- hzero-register 注册中心(多版本支持)
- hzero-config 配置中心中心(多版本支持)
- hzero-gatway 网关服务,合并hzero-gateway-helper鉴权
- hzero-oauth 认证服务
- hzero-swaggr API测试服务
- hzero-iam 用户身份服务
- 访问网关、鉴权
-
API访问gateway网关服务,所有请求都会经过GateWayHelperFilter过滤器,在过滤器中,会调用gateway-helper鉴权。进入gateway-helper,根过滤器RootServletFilter包含了一系列过滤器来对请求进行鉴权,将按途中的过滤器顺序进行校验,其中任何一步返回false都会直接返回,一般服务出现403、500等问题可先检查hzero-gateway-helper的日志,看是哪一步校验不通过。校验通过后携带jwt返回到gateway
-
API访问gateway网关服务,所有请求都会经过GateWayHelperFilter过滤器,在过滤器中,会调用gateway-helper鉴权。进入gateway-helper,根过滤器RootServletFilter包含了一系列过滤器来对请求进行鉴权,将按途中的过滤器顺序进行校验,其中任何一步返回false都会直接返回,一般服务出现403、500等问题可先检查hzero-gateway-helper的日志,看是哪一步校验不通过。校验通过后携带jwt返回到gateway
Hzero本地部署(准备工作)参考文档
-
本地部署
本地安装方式一般用于搭建开发环境,在服务器上部署好基础服务后,开发人员在本地只需要关注自己的服务,进行API测试。在本地电脑安装6个基础服务搭建起基础开发环境。
-
基础服务
- hzero-register 注册中心
- hzero-config 配置中心
- hzero-gateway 网关服务
- hzero-oauth 认证服务
- hzero-swaggr API测试服务
- hzero-iam 用户身份服务
-
环境准备
- 基础环境:
- JDK1.8
- Maven3.0+
- Redis
- 数据库
- Hosts域名映射
- 虚拟机地址 db.hzero.org
- 虚拟机地址 redis.hzero.org
- 127.0.0.1 dev.hzero.org
- 基础环境:
Hzero本地部署(数据库初始化)
-
数据初始化
-
创建用户
create user 'hzero'@'%' identified by 'hzero'
-
创建库
create database hzero_platform default character set utf8mb4
create database hzero_governace default character set utf8mb4
grant all privileges on hzero_platform.* to 'hzero'@'%'
grant all privileges on hzero_governance.* to 'hzero'@'%'
flush privileges
-
初始化表结构
修改脚本文件,需要注意的是先要看jar包的对应目录是否存在,再修改数据库连接信息,再根据你是要初始化表结构(service值需要替换、dir也要替换;替换的目录是建表脚本的目录)还是初始化数据替换service和dir。如下就是初始化hzero_platform库中的表结构。
service=hzero_platform schema=$service dir=groovy/$service
初始化数据
表更新规范
-
‘0’租户处理
手工修改fd_organization hpfm_tenant hpfm_group三张表的数据,需手动将Hzero这个租户的id设置为0
-
Hzero项目demo 后端项目搭建教程
- 先看项目骨架:
)。
应用分层
至少需要包含如下的结构,将业务和流程分开,应用服务专注用例调度,反应用户故事;领域对象/服务专注核心业务。整个模块通用的放到基础设施层,资源库和外部服务实现也放到基础设施层,屏蔽实现细节。- api 向外提供接口
- app 负责用例调度,事务控制
- domain 领域对象和领域服务,专注核心业务
- infra 基础设施,保持数据的持久化、防腐层、第三方库、消息等
- api
- controller 提供接口服务
- dto 用来封装复杂的数据对象,多用来给需要多个实体组合时提供数据传输
- app
- service 应用服务,事务控制、流程调度
- impl 实现
- assembler dto组装器
- service 应用服务,事务控制、流程调度
- domain
- entity 表的体现,能简单自治(限制长度,限制主键等等)
- service 封装领域内复杂的业务逻辑
- repository 资源库接口,提供数据资源的操作方法,简单的增删改查和redis的增删查改
- vo 值对象,封装没有实体但是又会在领域内用的数据
- infra
- mapper 接口
- repository.impl repository的实现,业务不能入侵到这里
开发步骤
- 实体
- 类继承AuditDomain,添加@ModifyAudit、@VersionAudit、@Table、@JsonInclude(JsonInclude.Include.NON_NULL)、@ApiModel注解。
- 与该表对应的属性添加注解@Id、@GeneratedValue、@NotNull、@ApiModelProperty、@Length
- 非该表属性,但是能用到的添加@Transient、@ApiModelProperty注解
代码如下:
package com.hzero.test.domaindriverdesign.domain.entity;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.choerodon.mybatis.annotation.ModifyAudit;
import io.choerodon.mybatis.annotation.VersionAudit;
import io.choerodon.mybatis.domain.AuditDomain;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.validation.constraints.NotNull;
import java.util.UUID;
/**
* @date 2019/7/30
*/
@ApiModel("任务信息")
@ModifyAudit
@VersionAudit
@Table(name = "todo_task")
@JsonInclude(JsonInclude.Include.NON_NULL)
@Data
public class Task extends AuditDomain {
public static final String FIELD_ID = "id";
public static final String FIELD_EMPLOYEE_ID = "employeeId";
public static final String FIELD_STATE = "state";
public static final String FIELD_TASK_DESCRIPTION = "taskDescription";
@Id
@GeneratedValue
private Long id;
@NotNull(message = "用户ID不能为空")
@ApiModelProperty("用户ID")
private Long employeeId;
@ApiModelProperty("任务状态")
private String state;
@ApiModelProperty("任务编号")
private String taskNumber;
@Length(max = 240)
@ApiModelProperty("任务描述")
private String taskDescription;
@NotNull
@ApiModelProperty("租户ID")
private Long tenantId;
@Transient
@ApiModelProperty("员工编号")
private String employeeNumber;
@Transient
@ApiModelProperty("员工姓名")
private String employeeName;
/**
* 生成任务编号
*/
public void generateTaskNumber() {
this.taskNumber = UUID.randomUUID().toString().replace("-", "");
}
}
- 资源库(repository)
- 都是接口,接口继承BaseRepository<>接口,BaseRepository中提供了一些基本的crud方法
- controller中能直接调用这里的接口,不用再app中service里再封装
- 开发服务(app.service)
- 开发controller(controller)
- 开发mapper和mapper.xml(mapper)
- 一般单表操作使用jpa就够了
- 资源库实现(repository.impl)
- 应用服务实现(service.impl)