Thư viện là một dự án tập lệnh có các hàm có thể được sử dụng lại trong các tập lệnh khác.
Có quyền truy cập vào thư viện
Để đưa một thư viện vào dự án, bạn phải có quyền truy cập ít nhất ở cấp chế độ xem. Nếu bạn không phải là tác giả của thư viện mà bạn muốn đưa vào, hãy liên hệ với tác giả và yêu cầu quyền truy cập.
Bạn cần mã tập lệnh của thư viện mà bạn muốn đưa vào. Khi có quyền truy cập vào thư viện, bạn có thể tìm thấy mã tập lệnh trên trang Project Settings (Cài đặt dự án).
Thêm thư viện vào dự án tập lệnh
- Ở bên trái trình soạn thảo Apps Script, bên cạnh "Thư viện", hãy nhấp vào biểu tượng Thêm thư viện .
- Trong trường "Mã tập lệnh", hãy dán mã tập lệnh của thư viện.
- Nhấp vào Tìm kiếm.
- Nhấp vào trình đơn thả xuống Phiên bản rồi chọn phiên bản thư viện cần sử dụng.
- Kiểm tra xem tên "Giá trị nhận dạng" mặc định có phải là tên bạn muốn sử dụng với thư viện này hay không. Đây là tên mà tập lệnh của bạn sử dụng để tham chiếu đến thư viện. Ví dụ: nếu đặt giá trị này thành
Test, bạn có thể gọi một phương thức của thư viện đó như sau:Test.libraryMethod(). - Nhấp vào Thêm.
Sử dụng thư viện
Sử dụng thư viện đi kèm như cách bạn sử dụng dịch vụ mặc định. Ví dụ: nếu Test là giá trị nhận dạng cho thư viện của bạn, hãy nhập Test, theo sau là dấu chấm để xem danh sách các phương thức trong thư viện.
Bạn có thể mở tài liệu tham khảo cho một thư viện đi kèm bằng cách làm theo các bước sau:
Ở bên trái trình chỉnh sửa tập lệnh, bên cạnh tên thư viện, hãy nhấp vào biểu tượng Tuỳ chọn khác > Mở trong một thẻ mới.
Xoá thư viện
Ở bên trái trình soạn thảo tập lệnh, bên cạnh tên thư viện, hãy nhấp vào biểu tượng Tuỳ chọn khác > Xoá > Xoá thư viện.
Cập nhật thư viện
Bạn có thể thay đổi phiên bản của thư viện hoặc cập nhật giá trị nhận dạng của thư viện.
- Ở bên trái trình chỉnh sửa, trong phần "Thư viện", hãy nhấp vào tên thư viện.
- Chỉnh sửa rồi nhấp vào Lưu.
Tạo và chia sẻ thư viện
Để sử dụng và chia sẻ dự án tập lệnh dưới dạng thư viện, hãy làm theo các bước dưới đây.
- Tạo một bản triển khai có phiên bản của tập lệnh.
- Chia sẻ ít nhất quyền truy cập cấp chế độ xem với tất cả người dùng tiềm năng của thư viện.
- Cung cấp mã tập lệnh cho những người dùng đó. Bạn có thể tìm thấy mã này trên trang Cài đặt dự án.
Các phương pháp hay nhất
Dưới đây là một số nguyên tắc bạn cần tuân thủ khi viết thư viện:
- Chọn một tên có ý nghĩa cho dự án của bạn vì tên này được dùng làm giá trị nhận dạng mặc định khi thư viện của bạn được người khác đưa vào.
- Nếu không muốn người dùng thư viện nhìn thấy (hoặc sử dụng) một hoặc nhiều phương thức của tập lệnh, bạn có thể kết thúc tên của phương thức bằng dấu gạch dưới. Ví dụ:
myPrivateMethod_(). - Chỉ những người dùng thư viện mới thấy được các thuộc tính chung có thể liệt kê. Điều này bao gồm các nội dung khai báo hàm, biến được tạo bên ngoài hàm bằng
varvà các thuộc tính được đặt rõ ràng trên đối tượng toàn cục. Ví dụ:Object.defineProperty()vớienumerableđược đặt thànhfalsesẽ tạo một biểu tượng mà bạn có thể sử dụng trong thư viện, nhưng người dùng không thể truy cập vào biểu tượng này. Nếu muốn người dùng thư viện sử dụng tính năng tự động hoàn thành của trình soạn thảo tập lệnh và tài liệu được tạo tự động, bạn phải có tài liệu theo kiểu JSDoc cho tất cả các hàm. Ví dụ:
/** * Raises a number to the given power, and returns the result. * * @param {number} base the number we're raising to a power * @param {number} exp the exponent we're raising the base to * @return {number} the result of the exponential calculation */ function power(base, exp) { ... }
Phạm vi tài nguyên
Có hai loại tài nguyên khi bạn làm việc với thư viện: dùng chung và không dùng chung. Tài nguyên dùng chung có nghĩa là cả thư viện và tập lệnh bao gồm đều có quyền truy cập tích hợp vào cùng một thực thể của tài nguyên. Sơ đồ sau đây minh hoạ một tài nguyên dùng chung bằng ví dụ về Thuộc tính người dùng:
Tài nguyên không được chia sẻ có nghĩa là cả thư viện và tập lệnh bao gồm chỉ có quyền truy cập tích hợp vào thực thể của tài nguyên. Tuy nhiên, thư viện có thể cung cấp quyền truy cập vào các tài nguyên không dùng chung bằng cách có các hàm rõ ràng hoạt động trên các tài nguyên đó. Dưới đây là ví dụ về một hàm mà bạn sẽ đưa vào thư viện để hiển thị Thuộc tính tập lệnh:
function getLibraryProperty(key) {
const scriptProperties = PropertiesService.getScriptProperties();
return scriptProperties.getProperty(key);
}
Sơ đồ sau đây minh hoạ một tài nguyên không được chia sẻ bằng ví dụ về Thuộc tính tập lệnh:
Bảng này liệt kê các tài nguyên được chia sẻ và không được chia sẻ để bạn tham khảo:
| Tài nguyên | Đã chia sẻ* | Không được chia sẻ** | Ghi chú |
|---|---|---|---|
| Khoá |  |
Tất cả đều có thể thấy cùng một thực thể, bao gồm cả tập lệnh khi được tạo trong thư viện. | |
| Thuộc tính của tập lệnh | |
Tất cả đều có thể thấy cùng một thực thể, bao gồm cả tập lệnh khi được tạo trong thư viện. | |
| Bộ nhớ đệm | |
Tất cả đều có thể thấy cùng một thực thể, bao gồm cả tập lệnh khi được tạo trong thư viện. | |
| Điều kiện kích hoạt | |
Các trình kích hoạt đơn giản được tạo trong thư viện không được kích hoạt bằng tập lệnh bao gồm. | |
| ScriptApp | |
||
| UiApp |
|
||
| Thuộc tính người dùng | |
||
| Trình ghi nhật ký và bản chép lời thực thi | |
||
| Trang web, Trang tính và các vùng chứa khác | |
Lệnh gọi đến getActive() sẽ trả về vùng chứa của tập lệnh bao gồm. |
|
| MailApp và GmailApp | |
||
|
* Điều này có nghĩa là thư viện không có thực thể riêng của tính năng/tài nguyên mà thay vào đó đang sử dụng thực thể do tập lệnh đã gọi thư viện tạo ra.
** Điều này có nghĩa là thư viện có thực thể riêng của tài nguyên/tính năng và tất cả tập lệnh sử dụng thư viện đều chia sẻ và có quyền truy cập vào cùng một thực thể đó. | |||
Kiểm thử thư viện
Để kiểm thử thư viện, hãy sử dụng phương thức triển khai đầu. Bất kỳ ai có quyền truy cập cấp trình chỉnh sửa vào tập lệnh đều có thể sử dụng tính năng triển khai đầu.
Gỡ lỗi thư viện
Khi sử dụng trình gỡ lỗi trong một dự án có chứa thư viện, bạn có thể bước vào một hàm của thư viện được đưa vào. Mã sẽ xuất hiện trong trình gỡ lỗi ở chế độ chỉ xem và ở phiên bản phù hợp.