Git Submodules và ứng dụng trong việc chia sẻ tài nguyên dùng chung

Vấn đề

Trình quản lý gói (Package Manager) được tích hợp hay được tạo ra và sử dụng trong các ngôn ngữ lập trình là một cách hữu hiệu để chúng ta tái sử dụng mã được chia sẻ. Ví dụ như trong Javascript/Node.js có npm với hàng triệu packages được chia sẻ bởi rất nhiều lập trình viên trên thế giới. Mỗi khi cần gì, việc đầu tiên chúng ta thường làm là tìm xem có gói nào đáp ứng được nhu cầu để giảm thời gian phát triển phần mềm.

Việc chia sẻ các gói mà ai cũng có thể tìm kiếm và sử dụng đôi khi không phù hợp trong một số trường hợp, ví dụ chúng ta tạo ra các hàm tiện ích chỉ để sử dụng trong các dự án nội bộ của công ty hay cho riêng cá nhân mà không muốn chia sẻ với bất kì ai khác. Mặc dù nhiều trình quản lý gói cung cấp tính năng để "publish" các gói chia sẻ trong nội bộ, tuy nhiên điều đó vẫn có những hạn chế nhất định như chi phí, thời gian triển khai...

Trong git, có một tính năng gọi là submodule có thể giúp chúng ta giải quyết được trường hợp cần chia sẻ thư mục hoặc các tệp tin với nhau trong các repository, qua đó chúng ta không cần phải tốn nhiều công sức để chia sẻ những đoạn mã tiện ích giữa các dự án với nhau nữa. Chi tiết như thế nào thì hãy đọc tiếp bài viết dưới đây nhé.

Git submodule là gì?

Git Submodule là một tính năng mạnh mẽ trong Git cho phép thêm và quản lý các repository khác trong repository của bạn. Nó cung cấp một cách để tích hợp và theo dõi các phụ thuộc mã nguồn bên ngoài một cách dễ dàng.

Về cơ bản, một submodule là một kho lưu trữ Git được nhúng trong một kho lưu trữ Git khác. Nó hoạt động như một con trỏ chỉ đến một commit cụ thể trong một kho lưu trữ bên ngoài. Bằng cách sử dụng submodule, bạn có thể thêm và sử dụng thư viện mã nguồn bên ngoài, framework hoặc bất kỳ dự án nào khác như một thành phần của dự án.

Cách đơn giản nhất để hình dung submodule hoạt động là chia sẻ những đoạn mã dùng chung trong các dự án. Ví dụ, bạn tạo ra một repository chỉ chứa các tệp với các hàm tiện ích (utils), sau đó muốn sử dụng chúng trong một dự án khác thì chỉ cần tạo một thư mục liên kết đến repository tiện ích.

Việc tận dụng submodule mang lại cho chúng ta nhiều sự tiện lợi trong cộng tác và tái sử dụng mã, vì các submodule cũng là một kho lưu trữ git nên nó có thể được phát triển thêm tính năng, sửa lỗi, bảo trì... như các dự án thông thường khác. Khi muốn nhận thay đổi, chỉ cần một thao tác pull submodule về để lấy về mã mới nhất. Thậm chí chúng ta còn có thể tham gia phát triển submodule ngay trong dự án đang liên kết đến nó bằng cách truy cập vào thư mục chứa submodule và commit như bình thường.

Ứng dụng trong việc chia sẻ tài nguyên dùng chung

Giả sử chúng ta đang ở thư mục dự án A và muốn thêm submodule là B có url: https://git-hub.com/2coffee/awesomelibrary

Thêm một submodule bằng lệnh add:

$ git submodule add https://git-hub.com/2coffee/awesomelibrary

Kiểm tra lệnh trên vừa làm gì:

$ git status

On branch main

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)

 new file:   .gitmodules
 new file:   awesomelibrary

Git báo có 2 tệp mới được thêm vào, nó chứa chỉ dẫn cho submodule được liên kết.

Hãy thử mở file .gitmodules ra bạn sẽ thấy nội dung trông giống như là:

[submodule "awesomelibrary"]
 path = awesomelibrary
 url = https://git-hub.com/2coffee/awesomelibrary

Ngay bây giờ bạn có thể kiểm tra thư mục awesomelibrary và sử dụng các đoạn mã trong đó như nó thuộc về project.

Tổng kết

Bên cạnh việc sao chép mã hay đóng gói mã thành thư viện để sử dụng trong một dự án nội bộ khác, chúng ta còn có thêm một cách nữa là sử dụng git submodule. Nó đơn giản là liên kết một dự án git khác vào một thư mục nào đó trong project hiện tại, qua đó có thể thoải mái nhận những thay đổi mới nhất từ nó mà không cần phải làm thêm nhiều bước.

Tham khảo:

• Git - Submodules