🎉 [2024-11-07] 初始化提交: init project
This commit is contained in:
commit
bcc664f6ed
96
.gitea/workflows/confluence-sync.yaml
Normal file
96
.gitea/workflows/confluence-sync.yaml
Normal file
@ -0,0 +1,96 @@
|
||||
name: Publish to Confluence
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
# paths:
|
||||
# - '**'
|
||||
# - '!.gitignore'
|
||||
# - '!README.md'
|
||||
# workflow_dispatch: # 允许手动触发工作流
|
||||
# schedule:
|
||||
# # 每天晚六点十分执行一次
|
||||
# - cron: '10 10 * * *'
|
||||
|
||||
env:
|
||||
SEPARATOR: "," # 定义多文件分割符
|
||||
START_PREFIX: "<!--" # 定义需要同步的文件
|
||||
|
||||
jobs:
|
||||
confluence:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
# 检出文件
|
||||
- uses: https://gitea.com/actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Print current path
|
||||
run: |
|
||||
pwd
|
||||
ls
|
||||
|
||||
# 获取变更的文件
|
||||
- name: Get changed files
|
||||
id: changed-markdown-files
|
||||
uses: https://texous.cn/actions/changed-files@v44.5.5
|
||||
with:
|
||||
files: |
|
||||
**.md
|
||||
**.png
|
||||
files_ignore: |
|
||||
**.tpl.md
|
||||
quotepath: false
|
||||
separator: ${{env.SEPARATOR}}
|
||||
old_new_files_separator: ";"
|
||||
|
||||
# 打印所有变更的文件
|
||||
- name: Print all changed files
|
||||
if: steps.changed-markdown-files.outputs.any_changed == 'true'
|
||||
env:
|
||||
ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
|
||||
run: |
|
||||
IFS=${SEPARATOR}
|
||||
for file in ${ALL_CHANGED_FILES}; do
|
||||
echo "$file was changed, realfile $(echo $file | tr -d '\\')"
|
||||
done
|
||||
|
||||
# 构建添加 mark 指令
|
||||
- name: Setup mark
|
||||
if: steps.changed-markdown-files.outputs.any_changed == 'true'
|
||||
uses: https://texous.cn/actions/setup-mark-action@v1.0.1
|
||||
|
||||
# 编译以及发布到
|
||||
- name: Mark and to confluence
|
||||
if: steps.changed-markdown-files.outputs.any_changed == 'true'
|
||||
env:
|
||||
ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
|
||||
MARK_USER: ${{ secrets.ATLASSIAN_USERNAME }}
|
||||
MARK_PASS: ${{ secrets.ATLASSIAN_API_TOKEN }}
|
||||
MARK_URL: ${{ secrets.ATLASSIAN_BASE_URL }}
|
||||
run: |
|
||||
IFS=${SEPARATOR}
|
||||
for file in ${ALL_CHANGED_FILES}; do
|
||||
if [[ $(head -n 1 $(echo $file | tr -d '\\')) =~ ^$START_PREFIX ]]; then
|
||||
export temp_path=$(echo $file | tr -d '\\')
|
||||
export temp_filename=${temp_path##*/}
|
||||
export temp_filename=${temp_filename%.*}
|
||||
export temp_filename=${temp_filename%.*}
|
||||
echo "file: $temp_path, filename: $temp_filename"
|
||||
# 打印文件第一行信息
|
||||
head -n 1 $(echo $file | tr -d '\\')
|
||||
# 配置图片大小为 750
|
||||
# sed -i -E 's/(.*\!\[.*\]\(.*\))([ ]*<\!\-\-[ ]*width=[0-9]*[ ]*\-\->)*/\1<!-- width=750 -->/g' $temp_path
|
||||
# path 替换
|
||||
# sed -i -E 's/(.*\!\[.*\]\([ \t]*([a-zA-Z]\:)?(\.*(\/|\\))?([^:\r\n\t\!]*\.[a-zA-Z]+)[ \t]*\))([ ]*<\!\-\-[ \t]*width=[0-9]*[ \t]*\-\->)*/\1<!-- width-attach=750 -->/g' $temp_path
|
||||
# url 替换
|
||||
sed -i -E 's/(.*\!\[.*\]\([ \t]*(http(s)?:\/\/)([^:\r\n\t\!]*(\.[a-zA-Z]+)?)[ \t]*\))([ ]*<\!\-\-[ \t]*width=[0-9]*[ \t]*\-\->)*/\1<!-- width=750 -->/g' $temp_path
|
||||
# 标题添加锚点
|
||||
sed -i -E 's/([#]+[ ]+)(.*)/\1\2 :anchor(\2):/g' $temp_path
|
||||
sed -i -E "s@(\[.*\])(\(#)(.*)(\))@\1\2id-$(echo $temp_filename | tr -d '-')-\3\4@g" $temp_path
|
||||
# 构建及发布
|
||||
mark --ci --debug --trace --include-path $(pwd) -p $MARK_PASS -b $MARK_URL -f $temp_path || exit 1;
|
||||
else
|
||||
echo "$temp_path not config metadata info, ignore file"
|
||||
fi
|
||||
done
|
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
out/
|
||||
logs/
|
||||
target/
|
||||
.idea/
|
||||
*.log
|
||||
*.gz
|
||||
*.iml
|
||||
*.puml
|
||||
*.flattened-*.xml
|
13
任务/今日任务.md
Normal file
13
任务/今日任务.md
Normal file
@ -0,0 +1,13 @@
|
||||
## 20241106
|
||||
- [ ] 表结构设计
|
||||
- [ ] 方案评审
|
||||
- [ ] 基础架子搭建
|
||||
- [ ] 当前系统的访问量(QPS)
|
||||
-
|
||||
|
||||
## 20241105
|
||||
- [ ] 企赋网关技术架构图
|
||||
- [ ] 企赋网关处理流程图
|
||||
- [ ] 企赋网关技术方案
|
||||
- [ ] 核心包代码查看
|
||||
- [ ] M端和B端粗略体验
|
155
方案/20241105-外部能力接入服务技术方案.md
Normal file
155
方案/20241105-外部能力接入服务技术方案.md
Normal file
@ -0,0 +1,155 @@
|
||||
# 外部能力接入技术方案
|
||||
## 一、现状
|
||||
### 业务背景
|
||||
为了统一南北流量,规划开放平台和企赋网关。
|
||||
其中企赋网关负责外部能力的统一接入。
|
||||
本方案就是争对企赋网关做的设计
|
||||
|
||||
## 二、需求
|
||||
### 业务需求
|
||||
现在需要对接外部的物流能力(具体对接什么服务商需要根据 小冰 的调研结果来接入)。
|
||||
当前只是企赋网关的一个技术架构
|
||||
|
||||
## 三、设计目标
|
||||
### 实现的功能
|
||||
- 外部能力的接入
|
||||
- 主动请求接口接入
|
||||
- 外部信息回调接收
|
||||
- 签名验签
|
||||
- 内部标准接口
|
||||
- 同步异步请求
|
||||
- 异步回调业务服务
|
||||
- 接口适配
|
||||
- 匹配内部标准接口和外部请求
|
||||
- 接口聚合
|
||||
- 对能力的组合
|
||||
- 其余能力组件
|
||||
- 熔断限流
|
||||
- 异步队列
|
||||
- 失败重试
|
||||
- 异常告警
|
||||
|
||||
## 四、整体设计
|
||||
### 整体架构
|
||||
![](../材料/外部能力接入服务位置.png)
|
||||
|
||||
### 交互流程
|
||||
![](../材料/外部能力接入处理流程.png)
|
||||
|
||||
## 五、详细设计
|
||||
### 功能模块设计
|
||||
#### 功能列表
|
||||
- 挡板功能(开关切换是否发起正式请求)
|
||||
- 推单和拉单(给三方提交订单,从三方拉订单回来)
|
||||
- 白名单梳理,那些第三方是需要白名单的
|
||||
- 三方接口并发流量限制(第三方有限流的需要做控制)
|
||||
- 报文存储(什么时候发起存储)
|
||||
- 业务请求参数(拦截器)
|
||||
- 业务返回结果(拦截器)
|
||||
- 三方请求参数(方法保存)
|
||||
- 三方返回结果(方法保存)
|
||||
- 三方回调参数(方法保存)
|
||||
- 三方回调结果(方法保存)
|
||||
- 回调消费异步
|
||||
- 回调消息发MQ
|
||||
-
|
||||
|
||||
![](../材料/外部能力接入技术架构.png)
|
||||
#### 模块说明
|
||||
- 内部SDK
|
||||
- 给业务用来快速接入外部服务能力
|
||||
- 接入层
|
||||
- 主要用来对接外部服务的接口
|
||||
- 包括授权,验签等步骤
|
||||
- 适配层
|
||||
- 主要是用来将外部接口返回参数映射为标准信息
|
||||
- 聚合层
|
||||
- 主要用来聚合一些操作:比如有些操作是需要多个接口协作完成的,将会在聚合层处理
|
||||
- 标准接口层
|
||||
- 对内部提供标准能力接口
|
||||
- 对外部提供标准回调接口
|
||||
- 异步队列
|
||||
- 处理异步请求(MQ)
|
||||
- 重试组件
|
||||
- 处理失败或者可预知异常重试
|
||||
- 限流降级
|
||||
- 正对一些上游接口策略来定制
|
||||
- 异常处理
|
||||
- 对一些异常进行分类处理,执行实际需要的操作,重试/失败等
|
||||
|
||||
### 存储设计
|
||||
要考虑存储节点(什么时候发起存储)
|
||||
|
||||
#### 数据库(DB)
|
||||
```sql
|
||||
CREATE TABLE `default`.`eg_request_info`
|
||||
(
|
||||
`id` bigint(20) NOT NULL,
|
||||
`tenant_id` bigint(20) NOT NULL COMMENT '租户id',
|
||||
`request_id` bigint(20) NOT NULL COMMENT '请求id:客户端生成',
|
||||
`trx_id` bigint(20) NOT NULL COMMENT '请求记录id:服务端生成',
|
||||
`request_time` bigint(20) NOT NULL COMMENT '请求时间',
|
||||
`request_type` int(4) NOT NULL COMMENT '请求类型:比如下运单,查物流等',
|
||||
`exec_type` int(2) NOT NULL DEFAULT 1 COMMENT '执行类型:1=同步,2=异步',
|
||||
`request_status` int(2) NOT NULL DEFAULT 1 COMMENT '请求状态',
|
||||
`attach_info` varchar(255) NOT NULL DEFAULT '{}' COMMENT '附加信息',
|
||||
`callback_url` varchar(1000) NOT NULL DEFAULT '' COMMENT '异步回调链接',
|
||||
`create_user_id` bigint(20) NOT NULL COMMENT '创建人id',
|
||||
`create_by` varchar(32) NOT NULL COMMENT '创建人名称',
|
||||
`create_time` bigint(20) NOT NULL COMMENT '创建时间',
|
||||
`update_user_id` bigint(20) NOT NULL COMMENT '更新人ID',
|
||||
`update_by` varchar(32) NOT NULL COMMENT '更新人名称',
|
||||
`update_time` bigint(20) NOT NULL COMMENT '更新时间',
|
||||
`deleted` bigint(20) NOT NULL DEFAULT 0 COMMENT '删除标识:0=未删除,id=以删除',
|
||||
PRIMARY KEY (`id`),
|
||||
INDEX `idx_eg_reqeust_info_request_id`(`request_id`, `request_type`) USING BTREE,
|
||||
INDEX `idx_eg_request_info_trx_id`(`trx_id`, `request_type`) USING BTREE
|
||||
) COMMENT = '请求信息表';
|
||||
CREATE TABLE `default`.`eg_request_info_detail`
|
||||
(
|
||||
`id` bigint(20) NOT NULL,
|
||||
`trx_id` bigint(20) NOT NULL COMMENT '请求记录id:服务端生成',
|
||||
`request_info` text NOT NULL COMMENT '请求信息',
|
||||
`response_info` text NULL COMMENT '结果信息',
|
||||
`callback_info` text NULL COMMENT '回调信息',
|
||||
`create_user_id` bigint(20) NOT NULL COMMENT '创建人id',
|
||||
`create_by` varchar(32) NOT NULL COMMENT '创建人名称',
|
||||
`create_time` bigint(20) NOT NULL COMMENT '创建时间',
|
||||
`update_user_id` bigint(20) NOT NULL COMMENT '更新人ID',
|
||||
`update_by` varchar(32) NOT NULL COMMENT '更新人名称',
|
||||
`update_time` bigint(20) NOT NULL COMMENT '更新时间',
|
||||
`deleted` bigint(20) NOT NULL DEFAULT 0 COMMENT '删除标识:0=未删除,id=以删除',
|
||||
PRIMARY KEY (`id`),
|
||||
INDEX `idx_eg_request_info_detail_trx_id`(`trx_id`) USING BTREE
|
||||
) COMMENT = '请求信息详情表';
|
||||
```
|
||||
|
||||
#### ES
|
||||
- 由于请求会比较多,对数据库压力会比较大, 所以想把请求信息,回调信息存储到ES中
|
||||
- 对外部服务的请求报文也放入 ES, 后续好做查询追踪
|
||||
|
||||
### 接口设计
|
||||
**实际开始接入第三方后补充**。大体可以划分为几种类型
|
||||
1. 请求外部能力相关接口
|
||||
- 下运单
|
||||
- 查物流
|
||||
- ......
|
||||
2. 结果查询相关接口
|
||||
- 请求状态查询
|
||||
- ......
|
||||
3. 管理端管理相关接口
|
||||
- 请求报文查询
|
||||
- .....
|
||||
|
||||
### 潜在风险
|
||||
|
||||
## 六、工作量和排期
|
||||
### 开发时间
|
||||
### 联调时间
|
||||
### 提测时间
|
||||
### 上线时间
|
||||
|
||||
|
||||
## 七、设计评审意见
|
||||
|
||||
## 八、参考文档
|
32
杂项/20241105-入职梳理.md
Normal file
32
杂项/20241105-入职梳理.md
Normal file
@ -0,0 +1,32 @@
|
||||
# 入职梳理
|
||||
|
||||
## 技术栈
|
||||
- [ ] 技术选型
|
||||
- [ ] JDK(11)
|
||||
- [ ] Maven(私服,已配置)
|
||||
- [ ] Git(Gitlab自建)
|
||||
- [ ] 基础脚手架
|
||||
- [ ] MQ(RocketMQ)
|
||||
- [ ] DB(Mysql)
|
||||
- [ ] 服务间调用方式(Feign/Http)
|
||||
- [ ] 链路追踪(Skywalking)
|
||||
- [ ] 服务监控和日志采集(Graylog)
|
||||
- [ ] 版本管理
|
||||
- [ ] 流程
|
||||
- [ ] 版本号
|
||||
- [ ] 基础脚手架
|
||||
- [ ] 服务调用方式(HTTP,RPC)
|
||||
- [ ] 数据库设计规范(字段,索引)
|
||||
- [ ] 基础组件对接
|
||||
- [ ] ORM 框架(MybatisPlus)
|
||||
- [ ] Redis 对接(SpringDataRedis)
|
||||
- [ ] 分布式锁 redisson
|
||||
- [ ] MQ 对接(RocketMQ)
|
||||
- [ ] ES 或者数仓
|
||||
|
||||
## 业务梳理
|
||||
- [ ] 网络拓补图
|
||||
- [ ] 整体流程图
|
||||
- [ ] 系统架构图
|
||||
- [ ] 系统调用链路图
|
||||
-
|
BIN
材料/外部能力接入处理流程.png
Normal file
BIN
材料/外部能力接入处理流程.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 99 KiB |
BIN
材料/外部能力接入技术架构.png
Normal file
BIN
材料/外部能力接入技术架构.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 74 KiB |
BIN
材料/外部能力接入服务位置.png
Normal file
BIN
材料/外部能力接入服务位置.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 300 KiB |
BIN
材料/外部能力接入表设计.png
Normal file
BIN
材料/外部能力接入表设计.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 78 KiB |
BIN
材料/技术架构.png
Normal file
BIN
材料/技术架构.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 251 KiB |
Loading…
Reference in New Issue
Block a user