Computer >> Hướng Dẫn Máy Tính >  >> Hệ Thống >> Android

Thành thạo dự án Android đa thư viện: Best Practice cho phát triển Local và Remote

Thành thạo dự án Android đa thư viện: Best Practice cho phát triển Local và Remote

Trong bài này, chúng ta sẽ nói về dự án đa thư viện (multi-library) trong Android. Nó không quá phổ biến, nhưng cũng không quá hiếm.

Bạn có thể đã gặp dự án đa thư viện trong công việc, hoặc đang xem xét chia thư viện thành sub-module để cấu trúc và tổ chức tốt hơn. Dù trường hợp nào, bạn nên nắm rõ những gì phía trước trước khi lao vào.

Viết thư viện riêng trong Android很酷. Bạn có cơ hội viết code giúp developer khác (hoặc chính bạn).

Vì thư viện không thể là dự án độc lập, chúng thường luôn ghép cặp trong dự án với một ứng dụng. Điều này cho phép phát triển thư viện trở nên đơn giản: bạn thêm tính năng/sửa bug và test trực tiếp với ứng dụng trong dự án. Do đó, mô phỏng (theo cách local) cách developer sẽ tích hợp thư viện của bạn.

Nhưng, nếu thư viện của bạn phụ thuộc vào một thư viện khác bạn đang phát triển?

Nếu bạn chưa biết, bạn nên biết rằng một thư viện (file aar) không thể chứa thư viện local khác bên trong nó. Nó có thể phụ thuộc thư viện remote (qua dependencies), nhưng không phải thứ local.

Android không hỗ trợ điều này, và dù một số giải pháp từng xuất hiện qua các năm (FatAar), chúng không luôn giải quyết triệt để và không cập nhật. Thậm chí có Google Issue Tracker yêu cầu tính năng này mở 꽤久 và nhận nhiều sự chú ý từ cộng đồng. Nhưng hãy xác định tường nào phá được, tường nào không.

Hãy tưởng tượng cấu trúc dự án như sau:

-- App | -- OuterLib | --- InnerLib 

Vì InnerLib không thể là một phần của dự án gốc, nó có thể ở đâu? Và làm sao bạn có thể làm việc local khi phát triển tính năng bên trong InnerLib?

Chúng ta sẽ trả lời các câu hỏi này trong bài viết.

Git Submodule

Đối với hầu hết vấn đề kỹ thuật, không chỉ có một giải pháp. Thường có nhiều hơn, nhưng mỗi giải pháp có nhược điểm. Câu hỏi là nhược điểm nào bạn thoải mái chịu đựng cuối ngày.

Để trả lời câu hỏi đầu, InnerLib có thể ở đâu, ta có vài lựa chọn:

  1. Làm InnerLib thành submodule của dự án gốc
  2. Làm InnerLib thành dependency remote riêng

Nếu bạn chưa biết về submodule trong Git, tài liệu Git là nơi tốt để làm quen. Trích dẫn (đoạn đầu):

Thường xảy ra khi làm việc trên một dự án, bạn cần dùng dự án khác từ bên trong. 👉 Có thể là thư viện bên thứ ba phát triển hoặc bạn phát triển riêng và dùng trong nhiều dự án cha. 👈 Vấn đề thường gặp: bạn muốn coi hai dự án tách biệt nhưng vẫn dùng được một từ trong cái kia.

Đoạn này cho thấy đúng use case của chúng ta. Dùng submodule có lợi ích. Toàn bộ code ở một chỗ, dễ quản lý, dễ phát triển local.

Nhưng submodule có điểm yếu. Một là bạn phải luôn nhận thức branch submodule đang trỏ đâu. Tưởng tượng: bạn ở branch release ở repo chính mà sub-module ở branch feature. Nếu không để ý, bạn release phiên bản code với thứ chưa sẵn sàng production. Oops.

Nghĩ trong team developer. Một lỗi bất cẩn có thể tốn kém.

Nếu lựa chọn đầu nghe có vấn đề, host thư viện ở repo khác là lựa chọn hai. Setup repo khá đơn giản, nhưng làm sao làm việc local bây giờ?

Làm việc Local

Giờ đã setup dự án đúng, chúng ta có thể có dòng tương tự này trong build.gradle của OuterLib:

dependencies { implementation 'url_to_remote_inner_lib_repository' } 

Làm sao để chu kỳ phát triển hiệu quả và dễ làm việc? Nếu phát triển tính năng trong InnerLib, làm sao test trong OuterLib? Hay trong ứng dụng?

Một giải pháp có thể nảy ra là import InnerLib local vào dự án OuterLib, trong khi InnerLib được .gitignored trong OuterLib. Bạn làm dễ dàng bằng chuột phải tên dự án ở menu bên trái Android Studio → New → Module.

Thành thạo dự án Android đa thư viện: Best Practice cho phát triển Local và Remote Cách import module (Bước 1)

Sau đó trong cửa sổ mở ra, chọn Import ở góc dưới trái:

Thành thạo dự án Android đa thư viện: Best Practice cho phát triển Local và Remote Cách import module (Bước 2)

Nghe dễ dàng và đơn giản, nhưng catch là gì?

Mỗi lần bạn sửa file thuộc InnerLib, thay đổi không phản ánh bên trong InnerLib vì nó bị ignore. Vì vậy, mỗi thay đổi muốn làm phải xảy ra bên trong InnerLib rồi import lại vào OuterLib để thấy thay đổi.

Điều này không có vẻ đúng. Phải có cách tốt hơn.

Với chỉ vài dòng trong file settings.gradle, chúng ta có thể đảm bảo file đồng bộ khi thay đổi trong InnerLib.

Khi import InnerLib vào dự án, Android Studio tạo bản sao của InnerLib và cache nó. Đó là lý do phải re-import thư viện mỗi lần thay đổi bên trong nó. Chúng ta có thể nói cho Android Studio biết tham chiếu file từ đâu dùng thuộc tính projectDir.

settings.gradle có thể trông như sau:

include ':outerLib', ':innerLib', ':app' 

Để tham chiếu InnerLib local, phải đổi settings.gradle thành:

include ':outerLib', ':innerLib', ':app' project('innerLib').projectDir = new File('PATH_TO_INNER_LIB') 

Dùng cách này, file InnerLib sẽ link tới working directory, nên mọi thay đổi sẽ phản ánh ngay lập tức.

Nhưng, chúng ta muốn linh hoạt khi làm việc local trên OuterLib với phiên bản remote của InnerLib. Cái chúng ta viết trên trong settings.gradle chỉ cho phép làm việc local và chắc chắn không muốn commit nó như vậy.

Maven Local

Nếu cách trên không thoải mái, có cách khác. Giống như bạn publish thư viện public với maven, bạn có thể làm tương tự local với maven local. Maven local là tập repository nằm local trên máy bạn.

Dưới đây đường dẫn mavenLocal tùy OS:

  • Mac → /Users/YOUR_USERNAME/.m2
  • Linux → /home/YOUR_USERNAME/.m2
  • Windows → C:\Users\YOUR_USERNAME.m2

Bản chất bạn publish thư viện local và link tới nó trong dự án. Làm vậy, chúng ta link dự án tới InnerLib.

Để cho phép cấu hình này, cần làm sau:

  1. Thêm mavenLocal() làm repository trong mệnh đề repositories. Để cho phép dự án tìm repository local
buildscript { repositories { mavenLocal() } } ... allprojects { repositories { mavenLocal() } } 
  1. Thay đổi dòng implementation trong dependencies để tham chiếu InnerLib như thể tham chiếu remote

  2. Để publish InnerLib local, tạo file publishingLocally.gradle với nội dung:

apply plugin: 'maven-publish' project.afterEvaluate { publishing { publications { library(MavenPublication) { setGroupId groupId // package thư viện của bạn setArtifactId artifactId version versionName // VD: 1.0 artifact bundleDebugAar pom.withXml { def dependenciesNode = asNode().appendNode('dependencies') def dependencyNode = dependenciesNode.appendNode('dependency') dependencyNode.appendNode('groupId', 'your_group_id') dependencyNode.appendNode('artifactId', 'your_artificat_id') dependencyNode.appendNode('version', 'your_version') } } } } } 
  1. Trong file build.gradle cấp ứng dụng, thêm dòng:
apply from: '/.publishingLocally.gradle 

Nếu tùy chọn này nghe hơi quá tốt để là thật, thực ra nó là vậy. Mặc dù một bên, chúng ta phát triển local seamless như làm việc với thư viện remote. Mặt khác, nếu thay đổi bất kỳ thứ gì trong InnerLib khi làm việc local, bắt buộc phải publish local lại. Mặc dù không tốn kém, nó tạo ra việc lặp lại nhàm chán.

Giải pháp cho làm việc Local và Remote

Chúng ta muốn tránh cần liên tục re-publish InnerLib package mỗi khi thay đổi local. Cần tìm cách làm dự án nhận biết những thay đổi đó.

Ở phần Làm việc Local, chúng ta tìm ra cách làm vậy, nhưng có vấn đề commit settings.gradle. Để giải quyết để làm việc cả local và remote với InnerLib, chúng ta sẽ dùng tham số định nghĩa trong file gradle.properties.

File gradle.properties là nơi lưu cài đặt cấp dự án cấu hình môi trường phát triển. Giúp đảm bảo tất cả developer trong team có môi trường dev nhất quán.

Một số cài đặt bạn có thể quen thấy trong file này: hỗ trợ AndroidX (android.useAndroidX=true) hoặc tham số JVM (org.gradle.jvmargs=-Xmx1536m).

Để giúp giải quyết tình huống, thêm tham số chỉ việc có muốn làm việc local hay không. kiểu như:

workingLocally = false 

Tham số này cho phép phân biệt cài đặt nào đang dùng, local hay production. Đầu tiên, thay đổi settings.gradle bằng cách wrap nó trong điều kiện kiểm tra tham số true:

include ':outerLib', ':innerLib', ':app' if (workingLocally.booleanValue()) { project('innerLib').projectDir = new File('PATH_TO_INNER_LIB') } 

Cách này, chúng ta chỉ dẫn dự án lấy file InnerLib local từ máy.

Nơi khác cần thay đổi logic là build.gradle. Thay vì lấy code thư viện remote trong block dependencies, chỉ dẫn có phụ thuộc local hay không.

dependencies { if (workingLocally.booleanValue()) { implementation 'innerLib' } else { implementation 'url_to_remote_repository' } } 

⚠️ Cảnh báo: Không bao giờ commit file gradle.properties khi làm việc local.

Hành trình dài và có vẻ khá mệt mỏi. Nhưng bây giờ chúng ta có setup toàn diện cho làm việc local và remote trên dự án đa thư viện.

Nếu gặp vấn đề hoặc muốn đóng góp ý kiến, hãy để comment.

Học lập trình miễn phí. Chương trình mở của freeCodeCamp đã giúp hơn 40.000 người có việc làm developer. Bắt đầu ngay