- 最近公司需要实现一个能够在 docker 容器中实现项目部署升级的功能，这个主要是满足内网操作的 docker 实现快速的部署升级，避免去服务器操作。实现了对项目的部署，升级，回滚操作，日志查看功能目前正在开发，就先把做完的贴出来分享一下吧。
- 首先 Docker里面的容器自己是不能升级自己的，所以只能再单独写一个专门操作部署升级的项目，通过操作本机的 cmd 命令的方式实现项目的部署升级操作。
代码
- 通过 idea 创建一个 springboot 项目， 引入 hutool 工具包和 swagger 依赖以及 mybatisPlus 的依赖。
- 控制层的代码，这个没有什么好说的，因为 docker 容器是借助 docker-compose 操作的，所以代码也是根据操作 docker-compose 的 shell 脚本开发的
@RestController
@RequestMapping("upgrade/project")
@Api(value = "升级项目", tags = "升级项目相关接口")
public class UpgradeProjectController extends BladeController {
@Autowired
private UpgradeProjectService upgradeProjectService;
@PostMapping("/upload-file/deployment")
@ApiOperation("上传文件,部署项目")
public R<String> upgradeProject(@RequestParam("file") @ApiParam(value = "二进制文件流") MultipartFile file,
@ApiParam(value = "文件类型（0：前端，1：后端）") Integer projectType,
@ApiParam("后端项目模块（xxljob/system/lowcode/pdf）")String projectModel,
@ApiParam("env文件需要修改的模块名称（pdf_version/xxljob_version/system_version/lowcode_version）")String envName,
@ApiParam("项目版本号，修改.env文件需要用到")String projectVersion,
@ApiParam(value = "项目升级日志",required = true)String upgradeLog){
if (file.isEmpty()) {
return R.fail("文件不能为空");
}
if (projectType == null){
return R.fail("项目类型不能为空");
}
if (StrUtil.isBlank(upgradeLog)){
return R.fail("升级日志不能为空");
}
UpgradeProject upgradeProject = new UpgradeProject();
upgradeProject.setProjectType(projectType);
upgradeProject.setUpgradeLog(upgradeLog);
upgradeProject.setOperationUserId(getUser().getUserId());
upgradeProject.setOperationUserName(getUser().getNickName());
upgradeProject.setProjectVersion(projectVersion);
// 后端项目升级需要的信息
if (projectType == 1) {
upgradeProject.setEnvName(envName);
upgradeProject.setProjectModel(projectModel);
}
return R.data(upgradeProjectService.upgradeProject(file,upgradeProject));
}
@GetMapping("/list")
@ApiOperation("查询部署记录")
public R<IPage<UpgradeProject>> getUpgradeLog(UpgradeProject upgradeProject, Query query){
upgradeProject.setOperationUserId(getUser().getUserId());
LambdaQueryWrapper<UpgradeProject> queryWrapper = Condition.getQueryWrapper(upgradeProject).lambda().orderByDesc(UpgradeProject::getCreateTime);
return R.data(upgradeProjectService.page(Condition.getPage(query), queryWrapper));
}
@GetMapping("/history/list")
@ApiOperation("查询历史记录")
public R<List<String>> getHistory(String model){
return R.data(upgradeProjectService.history(model));
}
@GetMapping("/rollback")
@ApiOperation("回退历史版本")
public R<String> rollbackProject(@ApiParam(value = "回退的模块") @RequestParam String model,
@ApiParam(value = "回退的版本号") @RequestParam String version,
@ApiParam(value = ".env文件需要修应该的模块") @RequestParam String envModel){
return R.data(upgradeProjectService.rollbackProject(model,version,envModel,getUser()));
}
}
- 业务层代码，这里主要是对 sh 脚本操作,这里有几个注意的点，首先代码里的文件上传路径都是 docker 相对与物理机的映射地址。
@Service
public class UpgradeProjectServiceImpl extends ServiceImpl<UpgradeProjectMapper, UpgradeProject> implements UpgradeProjectService {
// 前端页面上传路径
@Value("${upload.api.folder}")
private String apiFolder;
// 文件压缩路径
@Value("${upload.api.unzip}")
private String apiUnzip;
// 后端程序 docker 镜像上传目录
@Value("${upload.webapp.folder}")
private String webAppFolder;
// shell 脚本目录
@Value("${upload.shell.folder}")
private String shellFolder;
@Autowired
private ExecUtil execUtil;
@Override
public String upgradeProject(MultipartFile file, UpgradeProject upgradeProject) {
// 后端路径
String msg = "";
String FOLDER_PATH = webAppFolder;
if (upgradeProject.getProjectType() == 0){
FOLDER_PATH = apiFolder;
}
try {
// 上传文件到指定目录
File savePos = new File(FOLDER_PATH);
if (!savePos.exists()) { // 不存在，则创建该文件夹
savePos.mkdir();
}
// 上传该文件至该文件夹下
File newFile = new File(FOLDER_PATH + "/" + file.getOriginalFilename());
if (newFile.exists()){
// 如果存在则先删除
FileUtil.del(FOLDER_PATH + "/" + file.getOriginalFilename());
}
file.transferTo(newFile);
// 对前端文件进行解压
if (upgradeProject.getProjectType() == 0) {
// UnzipUtils.unzipFile(FOLDER_PATH + "/" + file.getOriginalFilename(), apiUnzip);
FileUtils.unpack(newFile,new File(apiUnzip));
}
Map<String, String> deploymentMap = execUtil.execShell("upgrade.sh",
// shell脚本在服务器上存放的位置,由于jar包无法获取到文件的路径只能先将资源文件下的shell脚本读取出来然后写会到服务器中
shellFolder,
// 项目类型
upgradeProject.getProjectType().toString(),
// 前端上传的文件
file.getOriginalFilename(),
// 项目升级的模块
StrUtil.isNotBlank(upgradeProject.getProjectModel()) ? upgradeProject.getProjectModel().trim() : "",
// .env中项目的版本名称
StrUtil.isNotBlank(upgradeProject.getEnvName()) ? upgradeProject.getEnvName() : "",
// 项目的版本号
StrUtil.isNotBlank(upgradeProject.getProjectVersion()) ? upgradeProject.getProjectVersion() : "");
// 对升级的结果进行分析
if (CollectionUtil.isNotEmpty(deploymentMap)){
// 如果出现错误的信息那么一定是部署出错了
if (StrUtil.isNotBlank(deploymentMap.get("error"))){
upgradeProject.setResultMsg(deploymentMap.get("error"));
upgradeProject.setUpgradeResult(1);
msg = deploymentMap.get("error");
} else if (StrUtil.isNotBlank(deploymentMap.get("msg"))){
// 这里可能会有空的现象
upgradeProject.setResultMsg(deploymentMap.get("msg"));
upgradeProject.setUpgradeResult(1);
msg = deploymentMap.get("msg");
}
} else {
upgradeProject.setResultMsg("未知错误");
upgradeProject.setUpgradeResult(0);
msg = "未知错误";
}
upgradeProject.setResultMsg(msg);
// oldVersion: bi_version=1.1.0 只取等号后面的版本号
if (upgradeProject.getProjectType() == 1) {
String oldVersion = getProjectOldVersionFromEnv(shellFolder, upgradeProject.getEnvName());
upgradeProject.setOldVersion(oldVersion.split("=")[1]);
}
// 将升级的信息进行落库
this.save(upgradeProject);
} catch (Exception e){
e.printStackTrace();
}
// 升级完成后删除文件
FileUtil.del(FOLDER_PATH + "/" + file.getOriginalFilename());
return msg;
}
@Override
public List<String> history(String model) {
List<String> tags = new ArrayList<>();
Map<String, String> deploymentMap = execUtil.execShell("upgrade.sh",
// shell脚本在服务器上存放的位置,由于jar包无法获取到文件的路径只能先将资源文件下的shell脚本读取出来然后写会到服务器中
shellFolder,
// 项目类型
"3",
model);
if (CollectionUtil.isNotEmpty(deploymentMap)){
// 如果出现错误的信息那么一定是部署出错了
if (StrUtil.isNotBlank(deploymentMap.get("error"))){
return tags;
} else if (StrUtil.isNotBlank(deploymentMap.get("msg"))){
String msg = deploymentMap.get("msg");
String[] split = msg.split(" ");
for (int i = 1; i < split.length; i++) {
tags.add(split[i]);
}
}
}
return tags;
}
@Override
public String rollbackProject(String model, String version, String envModel, BladeUser user) {
UpgradeProject project = new UpgradeProject();
project.setProjectModel(model);
project.setProjectVersion(version);
project.setUpgradeLog("回退历史版本");
project.setEnvName(envModel);
project.setProjectType(0);
project.setOperationUserId(user.getUserId());
project.setOperationUserName(user.getNickName());
project.setCreateTime(LocalDateTime.now());
String msg = "回退失败";
Map<String, String> map = execUtil.execShell("upgrade.sh", shellFolder, "4", model, envModel, version);
if (CollectionUtil.isNotEmpty(map)) {
if (StrUtil.isNotBlank(map.get("error"))) {
project.setUpgradeResult(0);
project.setResultMsg(map.get("error"));
msg = "升级成功";
} else if (StrUtil.isNotBlank(map.get("msg"))) {
project.setUpgradeResult(0);
project.setResultMsg(map.get("msg"));
msg = "升级成功";
}
} else {
project.setUpgradeResult(1);
project.setResultMsg("未知错误");
}
this.save(project);
return msg;
}
private String getProjectOldVersionFromEnv(String shellFolder,String envName) {
AtomicReference<String> projectVersion = new AtomicReference<>("");
// 读取文件内容到Stream流中，按行读取
Stream<String> lines;
try {
lines = Files.lines(Paths.get(shellFolder+"/.env"));
if (lines == null){
return projectVersion.get();
}
} catch (IOException e) {
throw new RuntimeException(e);
}
// 随机行顺序进行数据处理
lines.forEach(ele -> {
if (ele.contains(envName)){
projectVersion.set(ele);
}
});
return projectVersion.get();
}
}
shell 脚本
#! /bin/bash
if [ $1 -eq 0 ]; then
cd /dockerDir/www
# 修改.env版本号
elif [ $1 -eq 1 ]; then
cd /dockerData/dockerTar
docker load -i $2
cd /dockerData/webapp
# 修改.env版本号
sed -i "s/$4.*/$4=$5/g" .env
docker-compose up -d $3
elif [ $1 -eq 2 ]; then
cd /dockerData/dockerSql
docker exec -i mysql sh -c "mysql -u$2 -p$3" < $4
elif [ $1 -eq 3 ]; then
# 根据 docker 镜像查询历史版本
docker $2 --format '{{.Tag}}'
else
cd /dockerData/webapp
# 修改.env版本号
sed -i "s/$3.*/$3=$4/g" .env
docker-compose up -d $2
fi
下面是我使用到的两个工具类，一个是解压缩使用的一个是操作 shell 脚本使用的
// 操作 shell 脚本
@Slf4j
@Component
public class ExecUtil {
/**
* 执行shell脚本,脚本放在项目的resource目录下
* @param scriptName 脚本文件名，带不带sh后缀都可以
* @param para 参数数组
*/
public Map<String,String> execShell(String scriptName,String shellPath, String ... para) {
Map<String,String> map = new HashMap<>();
try {
String scriptPath = readerShell(shellPath,scriptName);
if (StrUtil.isBlank(scriptPath)){
log.error("没有找到shell脚本...");
return null;
}
ProcessBuilder pb = new ProcessBuilder("chmod", "+x", scriptPath);
Process authCmd = pb.start();
authCmd.waitFor();
String[] cmd = new String[]{"./" + scriptName};
//为了解决参数中包含空格
cmd= ArrayUtils.addAll(cmd,para);
// 添加操作系统
cmd = ArrayUtils.add(cmd, getOS());
pb = new ProcessBuilder(cmd);
pb.directory(new File(scriptPath.substring(0, scriptPath.length() - scriptName.length() - 1)));
Process ps = pb.start();
ps.waitFor();
BufferedReader stdInput = new BufferedReader(new InputStreamReader(ps.getInputStream()));
BufferedReader stdError = new BufferedReader(new InputStreamReader(ps.getErrorStream()));
String s;
StringBuffer msg = new StringBuffer("");
StringBuffer error = new StringBuffer("");
while ((s = stdInput.readLine()) != null) {
msg.append(s).append(" ");
log.info("{} script 日志:{}", scriptName, s);
}
while ((s = stdError.readLine()) != null) {
error.append(s).append(" ");
log.error("{} script 异常:{}", scriptName, s);
}
if (StrUtil.isNotBlank(msg)){
map.put("msg",msg.toString());
} else if (StrUtil.isNotBlank(error)) {
map.put("error",error.toString());
}
if (StrUtil.isBlank(msg) && StrUtil.isBlank(error)){
map.put("msg","");
}
} catch (Exception e) {
log.error("exec shell e", e);
}
return map;
}
private static String getOS() {
String property = System.getProperty("os.name");
if (property.startsWith("Mac")) {
return "Mac";
} else if (property.startsWith("Linux")) {
return "Linux";
} else if (property.startsWith("Windows")) {
return "win";
}
return "";
}
private String readerShell(String shellPath,String scriptName){
File file = new File(shellPath+"/"+scriptName);
if (file.exists()){
return shellPath+"/"+scriptName;
}
String scriptPath = "";
//返回读取指定资源的输入流
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(scriptName);
// 如果没有读取到资源则返回
if (inputStream == null){
return null;
}
try {
copyInputStreamToFile(inputStream,file);
} catch (IOException e) {
throw new RuntimeException(e);
}
scriptPath = file.getAbsoluteFile().toString();
return scriptPath;
}
private static void copyInputStreamToFile(InputStream inputStream, File file)
throws IOException {
try (FileOutputStream outputStream = new FileOutputStream(file)) {
int read;
byte[] bytes = new byte[1024];
while ((read = inputStream.read(bytes)) != -1) {
outputStream.write(bytes, 0, read);
}
}
}
}
// 解压缩工具类
@Slf4j
public class UnzipUtils {
@SuppressWarnings("resource")
public static String unZip(String rootPath, String sourceRarPath, String passWord) {
ZipFile zipFile = null;
String result = "";
try {
//String filePath = sourceRarPath;
String filePath = rootPath + sourceRarPath;
if (StringUtils.isNotBlank(passWord)) {
zipFile = new ZipFile(filePath, passWord.toCharArray());
} else {
zipFile = new ZipFile(filePath);
}
zipFile.setCharset(Charset.forName("GBK"));
zipFile.extractAll(rootPath);
} catch (Exception e) {
log.error("unZip error: "+e);
return e.getMessage();
}
return result;
}
/**
* 解压zip压缩文件到指定目录
*
* @param zipPath zip压缩文件绝对路径
* @param descDir 指定的解压目录
*/
public static void unzipFile(String zipPath, String descDir) throws IOException {
try {
File zipFile = new File(zipPath);
if (!zipFile.exists()) {
throw new IOException("要解压的压缩文件不存在");
}
File pathFile = new File(descDir);
if (!pathFile.exists()) {
pathFile.mkdirs();
}
InputStream input = new FileInputStream(zipPath);
unzipWithStream(input, descDir);
} catch (Exception e) {
throw new IOException(e);
}
}
/**
* 解压
*
* @param inputStream
* @param descDir
*/
private static void unzipWithStream(InputStream inputStream, String descDir) {
if (!descDir.endsWith(File.separator)) {
descDir = descDir + File.separator;
}
try (ZipInputStream zipInputStream = new ZipInputStream(inputStream, Charset.forName("GBK"))) {
ZipEntry zipEntry;
while ((zipEntry = zipInputStream.getNextEntry()) != null) {
String zipEntryNameStr = zipEntry.getName();
String zipEntryName = zipEntryNameStr;
if (zipEntryNameStr.contains("/")) {
String str1 = zipEntryNameStr.substring(0, zipEntryNameStr.indexOf("/"));
zipEntryName = zipEntryNameStr.substring(str1.length() + 1);
}
String outPath = (descDir + zipEntryName).replace("\\\\", "/");
File outFile = new File(outPath.substring(0, outPath.lastIndexOf('/')));
if (!outFile.exists()) {
outFile.mkdirs();
}
if (new File(outPath).isDirectory()) {
continue;
}
writeFile(outPath, zipInputStream);
zipInputStream.closeEntry();
}
log.info("======解压成功=======");
} catch (IOException e) {
log.error("压缩包处理异常，异常信息{}" + e);
}
}
//将流写到文件中
private static void writeFile(String filePath, ZipInputStream zipInputStream) {
try (OutputStream outputStream = new FileOutputStream(filePath)) {
byte[] bytes = new byte[4096];
int len;
while ((len = zipInputStream.read(bytes)) != -1) {
outputStream.write(bytes, 0, len);
}
} catch (IOException ex) {
log.error("解压文件时，写出到文件出错");
}
}
}
好了今天的分享就到这，以上是主要代码，数据库的操作这块因为是程序员的基本功所以就没有贴出来了，感兴趣的朋友可以随时私信交流。
960
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
