构建工程化:建立平台化工程体系

一、功能描述

工程化体系主要是解决能够统一进行打包的问题,故需要对整体进行描述

1.1、子项目描述

1.1.1、配置管理

对于每一个子项目而言,需要有专门的配置管理目录,目录的建议组建方式为conf/defalutconf/local,其中defalut目录下存放组建默认的启动时配置,local为客户环境部署更改之后的启动时配置。当我们更新包的时候,这里存在交互逻辑,具体如下:

在配置管理目录中使用conf/defaultconf/local的方式,可以有效地管理默认配置和本地配置的差异。

1.1.1.1、确定更新范围

首先,我们需要明确此次包更新的范围,包括需要更新的文件和配置。

1.1.1.2、合并配置更新

根据比较结果,手动或使用脚本将conf/default中的更新合并到conf/local中。具体步骤如下

1.1.1.3、新增配置项

conf/default中新增的配置项添加到conf/local中。

1.1.1.4、删除配置项

如果conf/default删除了某些配置项,评估是否也需要从conf/local中删除。

1.1.1.5、修改配置项

对于在conf/default中修改的配置项,检查conf/local是否也需要相应修改。需要注意的是,某些配置已经在客户环境中进行了定制,合并时要慎重。

1.1.2、主项目代码

对于每一个子项目而言,所有的源代码,建议放到src/目录下

1.1.3、更新日志路径

对于每一个子项目而言,每个模块自己更新时输出的更新日志或安装日志,包括成功,错误等等,建议放到logs/目录下

1.1.4、MakeFile打包脚本

对于每一个子项目而言,需要提供自己的打包脚本,都使用make指令所依赖的MakeFile来做,例如java语言本身使用maven打包,可以将相关命令写到MakeFile文件中;go语言使用go build打包,也是重写命令即可;以此类推;如果是非编译型语言,例如python、php等,建议对源码进行混淆或使用工具进行编译(压缩),减少源代码泄漏风险。

1.1.5、服务化脚本

对于每一个子项目而言,需要提供自己运行的进程管理脚本,建议使用service/目录,进程管理使用Supervisord,故需要提供子项目运行的所有运行配置,具体请参考Supervisord的文档。

1.1.6、外部依赖包

如果项目依赖一些外部依赖包,由于打包的时候会使用相关的包,请勿使用在线下载的方式或引用外部包的方式,而采取将这些包直接放到本地外部依赖包目录,建议使用lib/目录下,注意,这里不仅可以存储打包时依赖,也可以存放运行时依赖。

1.1.7、插件

如果项目存在插件模式,则建议使用目录extends/

1.1.8、打包后运行脚本目录

建议使用目录sh,这里面主要存储打包后运行该服务时自动化执行的命令,同时应该至少提供 start-linux.shstop-linux.shstart-win.batstop-win.bat等脚本,便于主层启停任务。

1.2、主目录描述

主目录主要考虑需要在外部调用主的MakeFile,然后里面会定义整个打包流程。

1.2.1、bin

bin目录存放所有的软件代码,所有子项目的目录都放在这里面

1.2.2、conf

conf目录存放主项目的配置

1.2.3、MakeFile

核心MakeFile,将调用子项目的MakeFile,并根据依赖顺序进行打包

1.2.4、service

存放主supervisord的配置,防止与其他服务出现共用supervisord的情况,需要自己维护一个supervisord服务,故这里存储主supervisord系统服务和其注册脚本,以及主配置。

1.2.5、build

build目录存放打包之后的内容,打包前这个目录保持为空。

二、目录结构例子

以下是更新后的目录结构和说明,其中 bin 目录存放所有子项目的代码,每个子项目都有独立的子目录。

2.1、目录结构示例

my_project/
├── bin/
│   ├── sub_project1/
│   │   ├── conf/
│   │   │   ├── default/
│   │   │   │   └── sub_project1.conf
│   │   │   ├── local/
│   │   │       └── sub_project1.conf
│   │   ├── lib/
│   │   │   └── example_dependency1.jar
│   │   ├── logs/
│   │   ├── service/
│   │   │   ├── sub_project1.conf
│   │   ├── sh/
│   │   │   ├── start-linux.sh
│   │   │   ├── stop-linux.sh
│   │   │   ├── start-win.bat
│   │   │   └── stop-win.bat
│   │   ├── src/
│   │   │   ├── main.py
│   │   │   └── ...
│   │   ├── extends/
│   │   ├── Makefile
│   │   └── README.md
│   ├── sub_project2/
│   │   ├── conf/
│   │   │   ├── default/
│   │   │   │   └── sub_project2.conf
│   │   │   ├── local/
│   │   │       └── sub_project2.conf
│   │   ├── lib/
│   │   │   └── example_dependency2.jar
│   │   ├── logs/
│   │   ├── service/
│   │   │   ├── sub_project2.conf
│   │   ├── sh/
│   │   │   ├── start-linux.sh
│   │   │   ├── stop-linux.sh
│   │   │   ├── start-win.bat
│   │   │   └── stop-win.bat
│   │   ├── src/
│   │   │   ├── main.py
│   │   │   └── ...
│   │   ├── extends/
│   │   ├── Makefile
│   │   └── README.md
├── build/
├── conf/
│   ├── default/
│   │   └── main.conf
│   ├── local/
│       └── main.conf
├── lib/
│   └── common_dependency.jar
├── logs/
├── service/
│   ├── supervisord.conf
│   ├── main_project.conf
├── sh/
│   ├── start-linux.sh
│   ├── stop-linux.sh
│   ├── start-win.bat
│   └── stop-win.bat
├── Makefile
└── README.md

2.2、目录和文件说明

2.2.1、my_project/

  • 项目根目录,包含所有子目录和项目文件。

2.2.2、bin/

  • 存放所有子项目的目录,每个子项目都有独立的子目录。
2.2.2.1、sub_project1/
  • 子项目1的目录,结构与主项目类似。
    • conf/:存放子项目1的配置文件。
  • default/:默认配置。
  • local/:本地配置。
  • lib/:存放子项目1的外部依赖包。
  • logs/:存放子项目1的日志文件。
  • service/:存放子项目1的服务管理脚本和 Supervisord 配置文件。
  • sh/:存放子项目1的启动和停止脚本。
  • src/:存放子项目1的源代码。
  • extends/:存放子项目1的插件。
  • Makefile:子项目1的 Makefile 文件。
  • README.md:子项目1的说明文档。
2.2.2.2、sub_project2/
  • 子项目2的目录,结构与子项目1类似。

2.2.3、build/

  • 存放打包之后的内容。打包前这个目录保持为空。

2.2.4、conf/

  • 存放主项目的配置文件。
    • default/:存放默认的配置文件。
    • local/:存放本地环境的配置文件。

2.2.5、lib/

  • 存放项目依赖的外部包,不采用在线下载方式,而是直接放到本地。例如,Java 项目依赖的 common_dependency.jar

2.2.6、logs/

  • 存放主项目的日志文件。

2.2.7、service/

  • 存放主项目的服务管理脚本和 Supervisord 配置文件。
    • supervisord.conf:主 Supervisord 配置文件。
    • main_project.conf:主项目的 Supervisord 进程配置文件。
    • start-linux.sh:启动脚本(Linux)。
    • stop-linux.sh:停止脚本(Linux)。
    • start-win.bat:启动脚本(Windows)。
    • stop-win.bat:停止脚本(Windows)。

2.2.8、sh/

  • 存放打包后运行该服务时自动化执行的命令脚本。
    • start-linux.sh:打包后启动脚本(Linux)。
    • stop-linux.sh:打包后停止脚本(Linux)。
    • start-win.bat:打包后启动脚本(Windows)。
    • stop-win.bat:打包后停止脚本(Windows)。

2.2.9、Makefile

  • 核心 Makefile,将调用子项目的 Makefile,并根据依赖顺序进行打包。示例内容如下:
# 主Makefile
.PHONY: all clean
SUBPROJECTS := sub_project1 sub_project2
all: $(SUBPROJECTS)
$(SUBPROJECTS):$(MAKE) -C bin/$@
clean:@for subdir in $(SUBPROJECTS); do \$(MAKE) -C bin/$$subdir clean; \donerm -rf build/*

2.2.10、README.md

  • 项目的说明文档,描述项目的基本信息、安装步骤、使用方法等。

2.3、Supervisord 配置文件示例

2.3.1、supervisord.conf (主项目)

[supervisord]
logfile=/var/log/supervisord/supervisord.log
logfile_maxbytes=50MB
logfile_backups=10
loglevel=info
pidfile=/var/run/supervisord.pid
nodaemon=false
[unix_http_server]
file=/var/run/supervisor.sock
chmod=0700
[supervisorctl]
serverurl=unix:///var/run/supervisor.sock
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[include]
files = /opt/my_project/service/*.conf

2.3.2、my_project.conf (子项目)

[program:sub_project1]
command=python3 /opt/my_project/bin/sub_project1/src/main.py
autostart=true
autorestart=true
startsecs=5
stderr_logfile=/var/log/sub_project1/error.log
stdout_logfile=/var/log/sub_project1/access.log
environment=PYTHONPATH="/opt/my_project/bin/sub_project1/src"

2.4、服务化脚本示例

2.4.1、start-linux.sh (主项目)

#!/bin/bash
SUPERVISOR_CONF=/opt/my_project/service/supervisord.conf
supervisord -c $SUPERVISOR_CONF

2.4.2、stop-linux.sh (主项目)

#!/bin/bash
SUPERVISOR_CONF=/opt/my_project/service/supervisord.conf
supervisorctl -c $SUPERVISOR_CONF shutdown

2.4.3、start-win.bat (主项目)

@echo off
set SUPERVISOR_CONF=C:\path\to\my_project\service\supervisord.conf
supervisord -c %SUPERVISOR_CONF%

2.4.4、stop-win.bat (主项目)

@echo off
set SUPERVISOR_CONF=C:\path\to\my_project\service\supervisord.conf
supervisorctl -c %SUPERVISOR_CONF% shutdown

2.5、Makefile示例 (子项目)

2.5.1、Makefile (子项目1)

# 子项目
1的Makefile
.PHONY: all clean
all: build
build:# 这里可以添加编译或构建命令,例如:# javac -d bin/ src/*.javaecho "Building sub_project1"
clean:rm -rf build/*rm -rf logs/*

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/39176.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

TypeScript中,如何利用数组生成一个联合类型

本文由 ChatMoney团队出品 在开发中我们常常会遇到这样一个问题,代码如下: const arr ["a","b","c","d","e","f","g","h","i","j","k&quo…

利用区块链技术实现返利App的透明化追溯

利用区块链技术实现返利App的透明化追溯 大家好,我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编,也是冬天不穿秋裤,天冷也要风度的程序猿!今天我们将探讨如何利用区块链技术实现返利App的透明化追溯&#xff0c…

【信息学奥赛】CSP-J/S初赛06 信息编码(ASCLL码及汉字信息编码)

本专栏👉CSP-J/S初赛内容主要讲解信息学奥赛的初赛内容,包含计算机基础、初赛常考的C程序和算法以及数据结构,并收集了近年真题以作参考。 如果你想参加信息学奥赛,但之前没有太多C基础,请点击👉专栏&#…

51单片机点亮第一个LED灯

欢迎入群共同学习交流 时间记录&#xff1a;2024/7/2 一、电路原理图 二、代码程序 1.项目代码结构 2.主程序代码 #include <reg51.h>sbit ledP1^0;void delay(int ms) {int i0;while(ms--){for(i0;i<110;i);} }int main() {while(1){led 1;delay(1000);led 0;d…

01-android studio实现闪屏页功能

在Android开发中&#xff0c;闪屏页面是指应用程序启动时展示的第一个页面&#xff0c;通常用来展示应用的logo或者介绍信息&#xff0c;让用户在应用加载完毕前看到一个友好的界面。本文将介绍如何实现一个简单的Android闪屏页面。 一、创建一个新的SplashActivity 首先&…

EFCore_悲观锁与乐观锁(MySQL)

简述 悲观锁&#xff1a;对并发可能导致的资源抢占问题持悲观态度&#xff0c;总是认为会有其他的线程来抢占资源&#xff0c;所以会在实际上对资源上锁 乐观锁&#xff1a;对并发可能导致的资源抢占问题持乐观态度&#xff0c;并不对资源实际上锁&#xff0c;而是在对资源进行…

git 禁止dev合并到任何其他分支

创建 pre-merge-commit 钩子 导航到 Git 仓库的钩子目录&#xff1a; cd /path/to/your/repo/.git/hooks创建或编辑 pre-merge-commit 钩子&#xff1a; 也可以通过指令创建 nano pre-merge-commit在钩子文件中添加以下代码&#xff1a; #!/bin/sh# 获取当前分支名称 curr…

矮油,希喂、喜崽、爱立方主食冻干是超贵的进口平替?最新测评

相信很多铲屎官一到选粮就苦恼&#xff0c;尤其是主食冻干&#xff0c;虽说主食冻干对猫咪的好处是普通猫粮无法比的&#xff0c;其价格也是远超普通猫粮的。所以很多铲屎官就很担心&#xff0c;花了高价买的主食冻干却营养不高。其实除了营养还有更多需要考虑的&#xff0c;比…

Spring Boot与Solr的集成应用

Spring Boot与Solr的集成应用 大家好&#xff0c;我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编&#xff0c;也是冬天不穿秋裤&#xff0c;天冷也要风度的程序猿&#xff01;今天我们来聊聊Spring Boot与Solr的集成应用。Solr是一个高性能的开源搜索平台&am…

proto的前后端使用

首先定义一个input.proto文件 内容如下 syntax "proto3";message InputData {int32 UserId 1; // 将 number 改为 int32 或 int64string UserInput 2;string DrunkState 3; }message ResponseData {string AIResponse 1;string prompt 2;string emoti…

VBA提取word表格内容到excel

这是一段提取word表格中部分内容的vb代码。 Sub 提取word表格() mypath ThisWorkbook.Path & "\"myname Dir(mypath & "*.doc*")n 4 index of rowsRange("A1:F1") Array("课程代码", "课程名称", "专业&…

Linux miniconda 安装tensorflow-gpu遇到找不到GPU问题

背景&#xff1a; Linux Miniconda python3.9 安装步骤 1、 pip install tensorflow-gpu2.8.0 -i https://pypi.tuna.tsinghua.edu.cn/simple 2、报错如下&#xff1a; 更换镜像源&#xff0c;单独安装 pip install tf-estimator-nightly2.8.0.dev2021122109 -i https:/…

Java中的机器学习模型集成与训练实践

Java中的机器学习模型集成与训练实践 大家好&#xff0c;我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编&#xff0c;也是冬天不穿秋裤&#xff0c;天冷也要风度的程序猿&#xff01; 机器学习模型集成概述 在实际应用中&#xff0c;机器学习模型的集成与训…

主从同步binlog

主从同步的原理是怎样的 提到主从同步的原理&#xff0c;我们就需要了解在数据库中的一个重要日志文件&#xff0c;那就是 Binlog 二 进制日志&#xff0c;它记录了对数据库进行更新的事件。实际上主从同步的原理就是基于 Binlog 进 行数据同步的。在主从复制过程中&#xff…

【2024】LeetCode HOT 100——二分查找

目录 1. 搜索插入位置1.1 C++实现1.2 Python实现1.3 时空分析2. 搜索二维矩阵2.1 C++实现2.2 Python实现2.3 时空分析3. 在排序数组中查找元素的第一个和最后一个位置3.1 C++实现3.2 Python实现3.3 时空分析4. 搜索旋转排序数组4.1 C++实现4.2 Python实现4.3 时空分析5. 寻找旋…

在U盘/移动硬盘上安装热插拔式Ubuntu系统,并将Docker目录挂载到NTFS硬盘

Windows10的WSL2的确给开发人员带来了很多方便&#xff0c;但是仍然有很多缺点。比如&#xff1a;太占系统内存&#xff1b;有些软件无法在WSL2中编译成功&#xff1b;相当于虚拟机&#xff0c;性能不如原装系统。 装双系统&#xff0c;相信大家都不陌生&#xff0c;但它会占用…

SpringBoot 项目整合 MyBatisPlus 框架,附带测试示例

文章目录 一、创建 SpringBoot 项目二、添加 MyBatisPlus 依赖三、项目结构和数据库表结构四、项目代码1、application.yml2、TestController3、TbUser4、TbUserMapper5、TestServiceImpl6、TestService7、TestApplication8、TbUserMapper.xml9、MyBatisPlusTest 五、浏览器测试…

网安小贴士(3)网安协议

一、前言 网络安全协议是构建安全网络环境的基础&#xff0c;它们帮助保护网络通信免受各种威胁和攻击。 二、定义 网络安全协议是指在计算机网络中用于确保网络通信和数据传输安全的协议。它们定义了在网络通信过程中的安全机制、加密算法、认证和授权流程等&#xff0c;以保…

为什么 [] == ![] 为 true?

&#x1f9d1;‍&#x1f4bb; 写在开头 点赞 收藏 学会&#x1f923;&#x1f923;&#x1f923; 前言 面试官问我&#xff0c;[] ![] 的结果是啥&#xff0c;我&#xff1a;蒙一个true&#xff1b; 面试官&#xff1a;你是对的&#xff1b;我&#xff1a;内心非常高兴&a…

继承QAbstractListModel,结合QListView

这里想要写一个QAbstractListModel的子类&#xff0c;学习一下如何实例化QAbstractListModel。 QAbstractListModel子类化-CSDN博客 QVariant与自定义类型互转之奇巧淫技_qt 类型转 qvariant-CSDN博客 #pragma once#include <QStyledItemDelegate> #include <qmeta…