Viết lớp mạng trong Swift: Protocol-Oriented Approach ( Phần 1 )

Bài đăng này đã không được cập nhật trong 5 năm

Trong bài hướng dẫn này, chúng ta sẽ biết cách để phát triển 1 lớp mạng bằng Swift thường mà không sử dụng bất kì thư viện thứ 3. Cho phép thực hiện ngay. Sau khi hoàn thành hướng dẫn này, code của chúng ta sẽ gồm:

protocol-oriented
Dễ sử dụng
Dễ dàng phát triển
An toàn
Sử dụng enums để cầu hình endPoints

Ví dụ phía dưới sẽ cho thấy điều mà chúng ta làm được sau khi hoàn thành với lớp mạng của mình:

Với việc chỉ việc viết router.requesr(. với sức mạnh của enums chúng ta có thể thấy tất cả endPoints cái sẽ được hiển thị với chúng ta và đối số cần thiết cho request.

Đầu tiên, 1 vài structure

Khi tạo ra bất cứ thứ gì, điều quan trọng nhất là cấu trúc, vì vậy nó sẽ dễ dàng sử dụng cho sau này. Tôi tin chắc rằng cấu trúc thư mục là chìa khóa giúp cho phát triển kiến trúc. Để giữ các files của bạn được rõ ràng, hãy tạo các groups bằng tay trước đó và tôi sẽ ghi chú nơi mà chúng nên tới. Đây là 1 cái nhìn tổng thể về cấu trúc của dự án. *(Hãy ghi chú tên đã được đề xuất, bạn có thể đặt tên classes và groups bất cứ gì mà bạn thích. ) *

EndPointType Protocol

Điều đầu tiên chúng ta cần là khai báo các giao thức EndPointType. Giao thức này sẽ chứa tất cả thông tin cần để cấu hình 1 EndPoint. Và cái gì là EndPoint? Ồ, bản chất nó là 1 URLRequest và bao gồm tất cả thông tin như là headers, truy vấn thông số, và body parameters. Giao thức EndPointType là nền tảng của lớp mạng chúng ta thực hiện. Nào, tạo 1 file và đặt tên nó là EndPointType. Đặt file trong nhóm Service. ( Không phải trong group EndPoint, điều này sẽ được rõ ràng khi chúng ta tiếp tục).

HTTP Protocols

EndPointType của chúng ta có 1 số giao thức HTTP mà cần cho việc xây dựng đầy đủ endPoint. Hãy cùng phân tích yêu cầu của giao thức

HTTPMethod

Tạo 1 file tên HTTPMethod và đặt nó vào nhóm Service. Enum sẽ được sử dụng để cài đặt phương thức của request.

HTTPTask

Tạo 1 file tên HTTPTask và đặt nó bên trong nhóm Service. HTTPTask chịu trách nhiệm cho việc cấu hình tham số cho các endPoint cụ thể. bạn có hể thêm vào rất nhiều trường hợp mà áp dụng cho yêu cầu của lớp mạng của bạn. Ví dụ tôi sẽ có 3 trường hợp

Chúng ta sẽ thảo luận về Parameter và cách chúng ta xử lý mã hóa tham số truyền vào trong phần tiếp theo.

HTTPHeaders

HTTPHeaders đơn giản chỉ là 1 typealias dành cho dictionary. Bạn có thể tạo cái này ở trên đầu file HTTPTask

public typealias HTTPHeaders = [String:String]

Parameters & Encoding

Tạo file tên là ParameterEncoding và đặt nó trong nhóm Encoding. Đầu tiên chúng ta định nghĩa một Parameters typealias. Chúng ta sử dụng 1 typealias để code được rõ ràng và ngắn gọn hơn

public typealias Parameters = [String:Any]

Tiếp theo, định nghĩa 1 giao thức ParameterEncoder cùng 1 phương thức mã hóa tĩnh. Phương thức mã hóa sẽ lấy 2 thông số là *** inout URLRequest, Parameters *** ( Để tránh mơ hồ từ đây, tôi sẽ coi tham số hàm sẽ là đối số.) INOUT là từ khóa Swift sẽ được định nghĩa đối số như là một đối số tham chiếu. Thông thường biến sẽ được truyền vào hàm như kiểu giá trị. Với việc đặt inout ở phía trước đối số cho phép chúng ta định nghĩa nó như kiểu biến tham chiếu. Để hiểu thêm về inout bạn có thể đọc tại đây . Giao thức ParameterEncoder sẽ được bổ sung bởi JSONParameterEncoder và URLPameterEncoder

public protocol ParameterEncoder {
 static func encode(urlRequest: inout URLRequest, with parameters: Parameters) throws
}

Một ParameterEncoder thực hiện 1 chức năng là mã hóa thông số. Phương thức này có thể không thành công nên nó cũng bắt lỗi và chúng ta cần xử lý.

Nó cung cấp khả năng để chuyển đổi lỗi tùy chọn bên trong lỗi tiêu chuẩn. Tôi luôn thấy mình khó khăn với việc xử lý giải mã 1 số lỗi mà Xcode đem lại. Bằng cách tùy chỉnh lỗi bạn có thể định nghĩa message lỗi của chính bạn và biết chính xác lỗi đó đến từ đâu. Bằng cách này tôi chỉ việc đơn giản tạo 1 enum kế thừa Error.

URLParameterEncoder

Tạo file tên URLParameterEncoder và đặt nó bên trong nhóm Encoding

Code bên trên lấy các thông số và khiến chúng an toàn như thông số URL. Bạn cũng nên biết rằng vài ký tự bị cấm sử dụng trong URLs. Thông số được phân cách bởi ký hiệu '&', vì vậy bạn cần cung cấp cho tất cả chúng. Chúng ta cũng thêm vào các headers cần thiết cho request nếu chúng chưa được thiết lập

Đoạn conde mẫu là cái mà chúng ta nên xem xét kiểm thử với Unit Tests. Nó quan trọng là URL được xây dựng 1 cách chính xác cũng như việc chúng ta có thể lấy ra được 1 số lỗi không cần thiết. Nếu bạn sử dụng API mở bạn không muốn request của bạn bị thất bại bởi 1 số bài test. nếu bạn muốn biết thêm về Unit Testing bạn có thể bắt đầu đọc bài post này bởi S.T.Huang.

JSONParameterEncoder

Tạo file tên JSONParameterEncoder và đặt nó bên trong nhóm Encoding

Gần giống mã hóa URLParameter nhưng ở đây chúng ta sẽ mã hóa thông số cho JSON và thêm vào những header cần thiết lần nữa.

NetworkRouter

Tạo file tên NetworkRouter và đặt nó bên trong nhóm Service. Chúng ta bắt đầu bằng định nghĩa hoàn chỉnh 1 typealias.

public typealias NetworkRouterCompletion = (_ data: Data?,_ response: URLResponse?,_ error: Error?)->()

Tiếp theo chúng ta khai báo 1 giao thức NetworkRouter

Một NetworkRouter có 1 EndPoint sẽ sử dụng để tạo request và mỗi request đã tạo được truyền vào response để hoàn thiện. Tôi đã từng thêm chức năng cancel tuyệt vời để sử dụng nhưng không sử dụng nó. Chức năng này ó thể được gọi bất cứ khi nào trong vòng đời của request và hủy nó. Điều đó rất quý giá nếu ứng dụng của bạn đang có tiến trình tải về hoặc tải lên. Chúng ta tận dụng 1 associatedtype ở đây như chúng ta muốn Router khớp xử lý với bất kỳ EndPointType. Không sử dụng associatedtype router nên có 1 EndPointType cụ thể. Thêm nữa, với associatedtype tôi khuyến khích tìm hiểu bài post này của NấthaTheRobot

Router

Tạo 1 file tên Router và đặt nó bên trong nhóm Service. Chúng ta khai báo biến task private của loại URLSessionTask. Task này thực chất là điều sẽ thực hiện tất cả công việc. CHúng ta sẽ giữ biến này private như cách chúng ta không muốn bất cứ luồng truy cập nào ngoài class sửa đổi task của chúng ta

Request

Ở đây chúng ta tạo 1 URLSession sử dụng shared session. Đây là cách rất đơn giản với việc tạo 1 URLSession. Nhưng nhắc qua là đây không phải cách duy nhất. Có nhiều hơn 1 cách cấu hình phức tạp ccuar 1 URLSession có thể là cách hoàn thiện sử dụng cấu hình có thể thay đổi hành vi của session. Để biết thêm tôi khuyến nghị dành thời gian để đọc bài post này

Ở đây chúng ta tạo request của mình bằng cách gọi buildRequest và đưa nó 1 router ở đay là 1 EndPoint. Cách này sẽ được gói trong khối do-try-catch giống buildRequest bởi vì lỗi có thể được bắt bởi mã hóa của chúng ta. Chúng ta đơn giản chuyển tất cả response, data và lỗi tới completion