Các lớp API nội bộ của tôi có nên là tất cả trong một gói không?

Question

Tôi đang làm việc chăm chỉ trong việc đóng gói API để sử dụng công cộng. Vì vậy, tôi đang cố gắng giới hạn các phương pháp chỉ tiếp xúc với những phương pháp mà tôi muốn công khai và hỗ trợ. Bên dưới này tất nhiên có vô số các phương thức truy cập giới hạn.

Sự cố là tôi có rất nhiều mã nội bộ cần truy cập các phương thức bị hạn chế này mà không cần đặt các phương thức đó thành công khai. Điều này tạo ra hai vấn đề:

• tôi không thể tạo giao diện cho giao tiếp giữa các lớp như này sẽ làm cho những phương pháp nội bộ của tôi công cộng.
• Tôi không thể truy cập các phương pháp được bảo vệ hoặc mặc định trừ khi tôi đặt đa số các lớp nội bộ của mình trong cùng một gói .

Vì vậy, tôi có khoảng 70 hoặc 80 lớp nội bộ trong các gói được tách biệt rõ ràng NHƯNG với các công cụ sửa đổi truy cập quá mức cho phép. Bạn có nói rằng một gói duy nhất là ít hơn của hai tệ nạn hoặc là có một cách tốt hơn để có thể che giấu các phương pháp nội bộ của tôi trong khi vẫn giữ các gói chi tiết hơn?

Tôi muốn tìm hiểu cách thực hành tốt nhất tại đây.

Tôi đã nhận thức được This

Answer 1

Có hai giải pháp cho câu hỏi của bạn không liên quan đến việc giữ tất cả các lớp học trong cùng một gói.

Cách đầu tiên là sử dụng mẫu Friend Accessor/Friend Package được mô tả trong (Thiết kế API thực tế, Tulach 2008).

Cách thứ hai là sử dụng OSGi. Có một bài báo here giải thích cách OSGi thực hiện điều này.

Câu hỏi liên quan: 1, 2, 3 và 4.

Answer 2

Một ví dụ có thể là Servlet API như bạn thấy họ đã tách ra API servlet chung và http thành hai gói.

Nếu bạn tách mã của mình trong một số api.jar và implementation.jar bạn có thể sử dụng giao diện để triển khai mà không hiển thị với người dùng api.jar. Nếu các đối tượng của các lớp không phụ thuộc vào gói của chúng, phải cộng tác theo bất kỳ cách nào, các phương thức của khóa học phải được hiển thị (ít nhất là trong quá trình thực hiện).

Answer 3

vâng, bạn không thể bảo vệ nội dung triển khai nội bộ khỏi quyền truy cập. Có một số công nghệ (như OSGi), cung cấp giải pháp cho rằng trong thời gian chạy/khởi động ứng dụng. Đây là một lỗ hổng mô-đun hóa thiết kế ngôn ngữ java (nhưng cũng rất khó để thêm vào sau đó do tính tương thích thấp).

Tôi thích quy ước để thêm các hiện vật có thể nhìn thấy công khai vào gói /api và nội bộ tới /nội bộ. Cuối cùng bạn kết thúc với.

 

# this package is allowed to be accessed by api-users 
com.foo.users.api 
# this is completely internal logic (api implementation) 
# should only be touched by the api-module itself. 
com.foo.users.internal 
 

Bằng cách này, bạn có thể tách biệt và cũng có thể chạy mã phân tích mã tĩnh.

Giống như với servlet-api đã đề cập ở trên, bạn thậm chí có thể chia nhỏ hơn nữa api so với impl cho các lọ khác nhau. Nhưng điều này liên quan đến nỗ lực nhiều hơn để xây dựng vòng đời và duy trì các mô-đun, vì vậy tôi sẽ chỉ làm điều đó ở nơi một phân chia thời gian chạy hoàn chỉnh có ý nghĩa (như trong jsr-spec so với impl).