使用git submodule解决高耦合度问题

2024-01-11 07:04

本文主要是介绍使用git submodule解决高耦合度问题,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

在开发我的笔记系统时,我遇到了一个问题。问题是,在api-gate服务中,我需要验证用户的access_code,但是access_code的生成逻辑是在auth2服务中实现的。这个问题从架构设计的层面上看,就是一个高耦合度问题。高耦合度会给代码的扩展代码麻烦,并给未来的系统维护带来隐患。

问题分析和解决

对于这个问题,我想第一个想到的是,将相关的代码抽出为一个模块,然后两边同时引用这个模块。但是评估了一下,这样做稍微麻烦了一些,因为我只想共享代码段,因此,最后我想到了git submodule命令。
在这里插入图片描述
即创建一个新的git仓库,将共享的代码块放在新的git仓库中,例如,上图的notes_redis_helper。然后再回到api-gate和auth2这两个git的本地仓库,通过git submodule add命令,将notes_redis_helper添加到本地仓库中。从而实现了代码段的共享。

git submodule 命令的优势

  • 代码复用:Git Submodule允许将一个Git仓库作为子模块引入到另一个Git仓库中,使得可以在多个项目中共享和复用代码。这样可以避免重复编写相同的代码,提高开发效率。

  • 独立维护:每个子模块都是独立的Git仓库,有独立的版本控制。这意味着可以在子模块中独立进行开发、提交和发布,而不影响主项目的开发和维护。这样可以更好地组织和管理代码,减少耦合性。

  • 版本控制:Git Submodule可以确保子模块和主项目之间的版本控制保持一致。当子模块的代码发生变化时,可以通过更新子模块来更新主项目中引用的代码。这样可以更好地管理和跟踪代码的变化。

  • 逻辑清晰:通过使用Git Submodule,可以将功能相关的代码组织在一起,使得项目的逻辑更加清晰和易于理解。每个子模块都可以专注于特定的功能或模块,有助于减少代码的复杂性和维护成本。

  • 并行开发:使用Git Submodule可以实现并行开发,不同的团队可以独立地开发和维护各自的子模块。这样可以提高团队的协作效率,加快项目的开发速度。
    (这一节内容为AI创作)

操作步骤

  1. 创建一个独立仓库,并将代码重构到这个仓库中,例如:git@gitee.com:hanshu_alan/notes_redis_helper.git。需要注意的是,我们这里实际上是代码段级别的共享,因此这个仓库不需要通过cargo new --lib 来初始化。
  2. 进入api-gate项目的src目录,运行git submodule add等命令。
git submodule add git@gitee.com:hanshu_alan/notes_redis_helper.git
git submodule init
git submodule update
  1. 进入auth2项目的src 目录,重复步骤2的操作。

使用体验

比正常情况要稍微麻烦一点,比如,我在api-gate本地仓库的目录下修改notes_redis_helper,那么操作步骤如下:

cd notes_redis_helper # 进入notes_redis_helper
git commit . -m changes
cd .. # 返回api-gate本地仓库
git commit . -m changes # 提交api-gate仓库的修改,实际上就是提交notes_redis_helper的当前commit id
git push
cd ../../auth2 # 进入auth2 本地仓库
cd src/notes_redis_helper  # 进入notes_redis_helper仓库
git pull
cd ..
git commit . -m # 提交auth2的修改,因为这时notes_redis_helper的最新commit id已经改变
git push

上面的代码来至于我的开源项目https://gitee.com/hanshu_alan
这篇文章收录我的Rust-实战专栏。请关注我,不要错过更新哟。

这篇关于使用git submodule解决高耦合度问题的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/593534

相关文章

Python数据验证神器Pydantic库的使用和实践中的避坑指南

《Python数据验证神器Pydantic库的使用和实践中的避坑指南》Pydantic是一个用于数据验证和设置的库,可以显著简化API接口开发,文章通过一个实际案例,展示了Pydantic如何在生产环... 目录1️⃣ 崩溃时刻:当你的API接口又双叒崩了!2️⃣ 神兵天降:3行代码解决验证难题3️⃣ 深度

Linux内核定时器使用及说明

《Linux内核定时器使用及说明》文章详细介绍了Linux内核定时器的特性、核心数据结构、时间相关转换函数以及操作API,通过示例展示了如何编写和使用定时器,包括按键消抖的应用... 目录1.linux内核定时器特征2.Linux内核定时器核心数据结构3.Linux内核时间相关转换函数4.Linux内核定时

python中的flask_sqlalchemy的使用及示例详解

《python中的flask_sqlalchemy的使用及示例详解》文章主要介绍了在使用SQLAlchemy创建模型实例时,通过元类动态创建实例的方式,并说明了如何在实例化时执行__init__方法,... 目录@orm.reconstructorSQLAlchemy的回滚关联其他模型数据库基本操作将数据添

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解(如@Bean)定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig?为什么使用 JavaConfig?Jav

Springboot3统一返回类设计全过程(从问题到实现)

《Springboot3统一返回类设计全过程(从问题到实现)》文章介绍了如何在SpringBoot3中设计一个统一返回类,以实现前后端接口返回格式的一致性,该类包含状态码、描述信息、业务数据和时间戳,... 目录Spring Boot 3 统一返回类设计:从问题到实现一、核心需求:统一返回类要解决什么问题?

Java使用Spire.Doc for Java实现Word自动化插入图片

《Java使用Spire.DocforJava实现Word自动化插入图片》在日常工作中,Word文档是不可或缺的工具,而图片作为信息传达的重要载体,其在文档中的插入与布局显得尤为关键,下面我们就来... 目录1. Spire.Doc for Java库介绍与安装2. 使用特定的环绕方式插入图片3. 在指定位

Springboot3 ResponseEntity 完全使用案例

《Springboot3ResponseEntity完全使用案例》ResponseEntity是SpringBoot中控制HTTP响应的核心工具——它能让你精准定义响应状态码、响应头、响应体,相比... 目录Spring Boot 3 ResponseEntity 完全使用教程前置准备1. 项目基础依赖(M

Java使用Spire.Barcode for Java实现条形码生成与识别

《Java使用Spire.BarcodeforJava实现条形码生成与识别》在现代商业和技术领域,条形码无处不在,本教程将引导您深入了解如何在您的Java项目中利用Spire.Barcodefor... 目录1. Spire.Barcode for Java 简介与环境配置2. 使用 Spire.Barco

解决idea启动项目报错java: OutOfMemoryError: insufficient memory

《解决idea启动项目报错java:OutOfMemoryError:insufficientmemory》:本文主要介绍解决idea启动项目报错java:OutOfMemoryError... 目录原因:解决:总结 原因:在Java中遇到OutOfMemoryError: insufficient me

maven异常Invalid bound statement(not found)的问题解决

《maven异常Invalidboundstatement(notfound)的问题解决》本文详细介绍了Maven项目中常见的Invalidboundstatement异常及其解决方案,文中通过... 目录Maven异常:Invalid bound statement (not found) 详解问题描述可