Blog · 18 tháng 9, 2023 · Steve Simpson · Tích hợp

Apex Web Service: Những viên gạch cho các phù thủy web

Giới thiệu:

Trong bài blog này, tôi sẽ đi sâu vào việc xây dựng các Apex web service tùy chỉnh trong Salesforce. Những dịch vụ này rất quan trọng khi bạn cần một tiến trình bên ngoài tương tác với Salesforce để lấy hay ghi dữ liệu, mà REST API chuẩn không đáp ứng được. Chúng ta sẽ đi qua năm ví dụ, độ phức tạp tăng dần, từ truy vấn chuẩn đến cập nhật.

Sơ đồ: năm ví dụ Apex web service tùy chỉnh được gọi từ Postman: GET trả về danh sách bản ghi, GET với đối tượng phản hồi, GET với tham số, POST, và POST với lỗi

Tổng quan về web service tùy chỉnh

Chúng ta sẽ khám phá năm ví dụ về web service tùy chỉnh:

GET dùng danh sách SObject chuẩn: Lấy dữ liệu bằng một danh sách SObject chuẩn.

Lớp bọc với phản hồi JSON: Cải thiện yêu cầu GET bằng cách bọc nó trong một phản hồi JSON.

Thêm tham số: Đưa tham số vào yêu cầu GET để lấy dữ liệu cụ thể hơn.

Dùng POST để chèn: Hiện thực một yêu cầu POST để chèn dữ liệu.

Trả về thông báo lỗi: Xử lý và trả về thông báo lỗi đúng cách.

Hiện thực các web service tùy chỉnh

Ví dụ 1: GET dùng danh sách SObject chuẩn

Trong ví dụ này, chúng ta định nghĩa một REST resource với một URI tùy chỉnh và chỉ định động từ HTTP (GET). Lớp nên được khai báo là global, và chúng ta trả về một danh sách các tài khoản chuẩn bằng một truy vấn đơn giản.

Code Apex: một REST resource với phương thức GET truy vấn Account và trả về danh sách với cách tuần tự hóa mặc định

Ví dụ 2: Lớp bọc với phản hồi JSON

Để kiểm soát dữ liệu gửi về cho máy khách, chúng ta dùng một đối tượng phản hồi. Thay vì trả về danh sách SObject, chúng ta trả về danh sách các đối tượng phản hồi tùy chỉnh, cung cấp một biểu diễn gọn nhẹ của khách hàng chỉ với ID và tên.

Code Apex: một phương thức GET xây dựng một đối tượng phản hồi chứa danh sách khách hàng

Ví dụ 3: Thêm tham số

Tham số là thiết yếu khi bạn cần dữ liệu cho một khách hàng cụ thể. Bằng cách đọc RestContext.params, bạn có thể lấy ID khách hàng và dùng nó trong mệnh đề WHERE của SOQL để lọc dữ liệu.

Code Apex: một phương thức GET đọc tham số customerid từ yêu cầu và trả về khách hàng đó trong một đối tượng phản hồi

Ví dụ 4: Dùng POST để chèn

Khi bạn cần ghi dữ liệu, phương thức POST được sử dụng. Trong ví dụ này, chúng ta tạo một đối tượng phản hồi và một đối tượng yêu cầu. Đối tượng yêu cầu nhận một khách hàng có tên, và chúng ta dùng JSON serializer để giải tuần tự hóa yêu cầu vào một lớp cụ thể. Sau khi tạo và chèn một tài khoản mới, một trạng thái thành công được trả về.

Code Apex: một phương thức POST phân tích phần thân yêu cầu, chèn một Account và trả về trạng thái thành công hoặc lỗi

Ví dụ 5: Trả về thông báo lỗi

Ví dụ này tương tự Ví dụ 4 nhưng có thêm xử lý lỗi. Khi có ngoại lệ, lỗi được bắt, thêm vào một danh sách, và mã trạng thái được đặt là 500 (hoặc bất kỳ số nào bạn muốn).

Code Apex: phương thức POST có xử lý lỗi, trả về thông báo lỗi và mã trạng thái HTTP 500

Kết luận

Qua các ví dụ này, chúng ta đã minh họa những viên gạch cơ bản để tạo các Apex web service tùy chỉnh trong Salesforce. Bắt đầu với một yêu cầu GET đơn giản, chúng ta đã tăng dần độ phức tạp, đưa vào tham số, yêu cầu POST và xử lý lỗi.

Hãy đón xem

Cảm ơn bạn đã đọc, và tôi mong sớm được chia sẻ thêm những chuyến phiêu lưu đầy kiến thức cùng bạn! Hãy theo dõi tại www.SteveTechArc.com và kênh YouTube @SteveTechArc (opens in a new tab). Hãy đăng ký và nâng cao hiểu biết của bạn về Salesforce và cách tích hợp nó với các hệ thống khác.

Góp phần thay đổi thế giới bằng cách chia sẻ kiến thức tích hợp với các kiến trúc sư đồng nghiệp và những ai đang trên hành trình trở thành kiến trúc sư!

Bản ghi lời thoại được AI hỗ trợ

STA 1.8