Nếu có một tập lệnh hiện đang sử dụng môi trường thời gian chạy Rhino và muốn sử dụng cú pháp và tính năng của V8, bạn phải di chuyển tập lệnh sang V8.
Hầu hết các tập lệnh được viết bằng thời gian chạy Rhino đều có thể hoạt động bằng thời gian chạy V8 mà không cần điều chỉnh. Thông thường, điều kiện tiên quyết duy nhất để thêm cú pháp và tính năng V8 vào tập lệnh là bật môi trường thời gian chạy V8.
Tuy nhiên, có một số ít sự không tương thích và sự khác biệt khác có thể khiến tập lệnh không hoạt động hoặc hoạt động không như mong đợi sau khi bật môi trường thời gian chạy V8. Khi di chuyển một tập lệnh để sử dụng V8, bạn phải tìm kiếm các vấn đề này trong dự án tập lệnh và khắc phục mọi vấn đề bạn tìm thấy.
Quy trình di chuyển sang V8
Để di chuyển một tập lệnh sang V8, hãy làm theo quy trình sau:
- Bật thời gian chạy V8 cho tập lệnh.
- Hãy xem xét kỹ các tính năng không tương thích được liệt kê bên dưới. Kiểm tra tập lệnh để xác định xem có bất kỳ sự không tương thích nào không; nếu có một hoặc nhiều sự không tương thích, hãy điều chỉnh mã tập lệnh để xoá hoặc tránh vấn đề.
- Hãy xem xét kỹ các điểm khác biệt khác được liệt kê bên dưới. Kiểm tra tập lệnh để xác định xem có sự khác biệt nào được liệt kê ảnh hưởng đến hành vi của mã hay không. Điều chỉnh tập lệnh để khắc phục hành vi này.
- Sau khi khắc phục mọi vấn đề không tương thích hoặc khác biệt khác đã phát hiện, bạn có thể bắt đầu cập nhật mã để sử dụng cú pháp V8 và các tính năng khác theo ý muốn.
- Sau khi điều chỉnh mã, hãy kiểm thử kỹ tập lệnh để đảm bảo tập lệnh hoạt động như mong đợi.
- Nếu tập lệnh của bạn là một ứng dụng web hoặc tiện ích bổ sung đã xuất bản, bạn phải tạo một phiên bản mới của tập lệnh có các điều chỉnh cho V8. Để cung cấp phiên bản V8 cho người dùng, bạn phải phát hành lại tập lệnh bằng phiên bản này.
Không tương thích
Rất tiếc, môi trường thời gian chạy Apps Script ban đầu dựa trên Rhino đã cho phép một số hành vi ECMAScript không chuẩn. Vì V8 tuân thủ các tiêu chuẩn, nên những hành vi này sẽ không được hỗ trợ sau khi di chuyển. Nếu không khắc phục được những vấn đề này, bạn sẽ gặp lỗi hoặc hành vi tập lệnh bị hỏng sau khi bật môi trường thời gian chạy V8.
Các phần sau đây mô tả từng hành vi và bước bạn phải thực hiện để sửa mã tập lệnh trong quá trình di chuyển sang V8.
Tránh for each(variable in object)
Câu lệnh for each (variable in object) đã được thêm vào JavaScript 1.6 và bị xoá để thay thế bằng for...of.
Khi di chuyển tập lệnh sang V8, hãy tránh sử dụng câu lệnh for each (variable in object).
Thay vào đó, hãy sử dụng for (variable in object):
// Rhino runtime var obj = {a: 1, b: 2, c: 3}; // Don't use 'for each' in V8 for each (var value in obj) { Logger.log("value = %s", value); } |
// V8 runtime var obj = {a: 1, b: 2, c: 3}; for (var key in obj) { // OK in V8 var value = obj[key]; Logger.log("value = %s", value); } |
Tránh Date.prototype.getYear()
Trong môi trường thời gian chạy Rhino ban đầu, Date.prototype.getYear() trả về năm có hai chữ số cho các năm từ 1900 đến 1999, nhưng năm có bốn chữ số cho các ngày khác. Đây là hành vi trong JavaScript 1.2 trở về trước.
Trong môi trường thời gian chạy V8, Date.prototype.getYear() sẽ trả về năm trừ đi 1900 theo yêu cầu của các tiêu chuẩn ECMAScript.
Khi di chuyển tập lệnh sang V8, hãy luôn sử dụng Date.prototype.getFullYear(). Hàm này sẽ trả về một năm gồm bốn chữ số bất kể ngày tháng.
Tránh sử dụng từ khoá dành riêng làm tên
ECMAScript nghiêm cấm sử dụng một số từ khoá dành riêng trong tên hàm và biến. Môi trường thời gian chạy Rhino cho phép nhiều từ trong số này, vì vậy, nếu mã của bạn sử dụng các từ đó, bạn phải đổi tên hàm hoặc biến.
Khi di chuyển tập lệnh sang V8, hãy tránh đặt tên biến hoặc hàm bằng một trong các từ khoá dành riêng.
Đổi tên bất kỳ biến hoặc hàm nào để tránh sử dụng tên từ khoá. Các từ khoá phổ biến dùng làm tên là class, import và export.
Tránh chỉ định lại biến const
Trong môi trường thời gian chạy Rhino ban đầu, bạn có thể khai báo biến bằng const, nghĩa là giá trị của biểu tượng không bao giờ thay đổi và các lượt gán trong tương lai cho biểu tượng sẽ bị bỏ qua.
Trong môi trường thời gian chạy V8 mới, từ khoá const tuân thủ tiêu chuẩn và việc gán cho một biến được khai báo là const sẽ dẫn đến lỗi thời gian chạy TypeError: Assignment to constant variable.
Khi di chuyển tập lệnh sang V8, đừng cố gắng chỉ định lại giá trị của biến const:
// Rhino runtime const x = 1; x = 2; // No error console.log(x); // Outputs 1 |
// V8 runtime const x = 1; x = 2; // Throws TypeError console.log(x); // Never executed |
Tránh sử dụng giá trị cố định XML và đối tượng XML
Tiện ích không chuẩn này cho ECMAScript cho phép các dự án Apps Script sử dụng trực tiếp cú pháp XML.
Khi di chuyển tập lệnh sang V8, hãy tránh sử dụng giá trị cố định XML trực tiếp hoặc đối tượng XML.
Thay vào đó, hãy sử dụng XmlService để phân tích cú pháp XML:
// V8 runtime var incompatibleXml1 = <container><item/></container>; // Don't use var incompatibleXml2 = new XML('<container><item/></container>'); // Don't use var xml3 = XmlService.parse('<container><item/></container>'); // OK |
Không tạo hàm trình duyệt tuỳ chỉnh bằng __iterator__
JavaScript 1.7 đã thêm một tính năng cho phép thêm một trình lặp tuỳ chỉnh vào bất kỳ lớp nào bằng cách khai báo hàm __iterator__ trong nguyên mẫu của lớp đó; tính năng này cũng được thêm vào môi trường thời gian chạy Rhino của Apps Script để tạo điều kiện thuận lợi cho nhà phát triển. Tuy nhiên, tính năng này chưa bao giờ là một phần của tiêu chuẩn ECMA-262 và đã bị xoá trong các công cụ JavaScript tuân thủ ECMAScript. Các tập lệnh sử dụng V8 không thể sử dụng cấu trúc trình lặp này.
Khi di chuyển tập lệnh sang V8, hãy tránh sử dụng hàm __iterator__ để tạo trình duyệt tuỳ chỉnh. Thay vào đó, hãy sử dụng trình lặp ECMAScript 6.
Hãy xem xét cấu trúc mảng sau:
// Create a sample array var myArray = ['a', 'b', 'c']; // Add a property to the array myArray.foo = 'bar'; // The default behavior for an array is to return keys of all properties, // including 'foo'. Logger.log("Normal for...in loop:"); for (var item in myArray) { Logger.log(item); // Logs 0, 1, 2, foo } // To only log the array values with `for..in`, a custom iterator can be used. |
Các ví dụ về mã sau đây cho thấy cách tạo một trình lặp trong thời gian chạy Rhino và cách tạo một trình lặp thay thế trong thời gian chạy V8:
// Rhino runtime custom iterator function ArrayIterator(array) { this.array = array; this.currentIndex = 0; } ArrayIterator.prototype.next = function() { if (this.currentIndex >= this.array.length) { throw StopIteration; } return "[" + this.currentIndex + "]=" + this.array[this.currentIndex++]; }; // Direct myArray to use the custom iterator myArray.__iterator__ = function() { return new ArrayIterator(this); } Logger.log("With custom Rhino iterator:"); for (var item in myArray) { // Logs [0]=a, [1]=b, [2]=c Logger.log(item); } |
// V8 runtime (ECMAScript 6) custom iterator myArray[Symbol.iterator] = function() { var currentIndex = 0; var array = this; return { next: function() { if (currentIndex < array.length) { return { value: "[${currentIndex}]=" + array[currentIndex++], done: false}; } else { return {done: true}; } } }; } Logger.log("With V8 custom iterator:"); // Must use for...of since // for...in doesn't expect an iterable. for (var item of myArray) { // Logs [0]=a, [1]=b, [2]=c Logger.log(item); } |
Tránh mệnh đề catch có điều kiện
Môi trường thời gian chạy V8 không hỗ trợ mệnh đề catch có điều kiện catch..if vì các mệnh đề này không tuân thủ tiêu chuẩn.
Khi di chuyển tập lệnh sang V8, hãy di chuyển mọi điều kiện catch bên trong phần nội dung catch:
// Rhino runtime try { doSomething(); } catch (e if e instanceof TypeError) { // Don't use // Handle exception } |
// V8 runtime try { doSomething(); } catch (e) { if (e instanceof TypeError) { // Handle exception } } |
Tránh sử dụng Object.prototype.toSource()
JavaScript 1.3 chứa phương thức Object.prototype.toSource() chưa bao giờ có trong bất kỳ tiêu chuẩn ECMAScript nào. Tính năng này không được hỗ trợ trong thời gian chạy V8.
Khi di chuyển tập lệnh sang V8, hãy xoá mọi hoạt động sử dụng Object.prototype.toSource() khỏi mã của bạn.
Các điểm khác biệt khác
Ngoài các vấn đề không tương thích nêu trên có thể gây ra lỗi tập lệnh, còn có một số khác biệt khác mà nếu không được khắc phục, có thể dẫn đến hành vi tập lệnh thời gian chạy V8 không mong muốn.
Các phần sau đây giải thích cách cập nhật mã tập lệnh để tránh những điều bất ngờ này.
Điều chỉnh định dạng ngày và giờ theo ngôn ngữ
Các phương thức Date toLocaleString(), toLocaleDateString() và toLocaleTimeString() hoạt động khác nhau trong thời gian chạy V8 so với Rhino.
Trong Rhino, định dạng mặc định là định dạng dài và mọi tham số được truyền vào sẽ bị bỏ qua.
Trong môi trường thời gian chạy V8, định dạng mặc định là định dạng ngắn và các tham số được truyền vào được xử lý theo tiêu chuẩn ECMA (xem tài liệu về toLocaleDateString() để biết thông tin chi tiết).
Khi di chuyển tập lệnh sang V8, hãy kiểm thử và điều chỉnh các kỳ vọng của mã về kết quả của các phương thức ngày và giờ theo ngôn ngữ cụ thể:
// Rhino runtime var event = new Date( Date.UTC(2012, 11, 21, 12)); // Outputs "December 21, 2012" in Rhino console.log(event.toLocaleDateString()); // Also outputs "December 21, 2012", // ignoring the parameters passed in. console.log(event.toLocaleDateString( 'de-DE', { year: 'numeric', month: 'long', day: 'numeric' })); |
// V8 runtime var event = new Date( Date.UTC(2012, 11, 21, 12)); // Outputs "12/21/2012" in V8 console.log(event.toLocaleDateString()); // Outputs "21. Dezember 2012" console.log(event.toLocaleDateString( 'de-DE', { year: 'numeric', month: 'long', day: 'numeric' })); |
Tránh sử dụng Error.fileName và Error.lineNumber
Trong V8 không theo thời gian, đối tượng Error JavaScript tiêu chuẩn không hỗ trợ fileName hoặc lineNumber làm tham số hàm khởi tạo hoặc thuộc tính đối tượng.
Khi di chuyển tập lệnh sang V8, hãy xoá mọi phần phụ thuộc trên Error.fileName và Error.lineNumber.
Một cách khác là sử dụng Error.prototype.stack.
Ngăn xếp này cũng không theo tiêu chuẩn, nhưng được hỗ trợ trong cả Rhino và V8. Định dạng của dấu vết ngăn xếp do hai nền tảng tạo ra có chút khác biệt:
// Rhino runtime Error.prototype.stack // stack trace format at filename:92 (innerFunction) at filename:97 (outerFunction) |
// V8 runtime Error.prototype.stack // stack trace format Error: error message at innerFunction (filename:92:11) at outerFunction (filename:97:5) |
Điều chỉnh cách xử lý các đối tượng enum đã chuyển đổi thành chuỗi
Trong môi trường thời gian chạy Rhino ban đầu, việc sử dụng phương thức JSON.stringify() của JavaScript trên đối tượng enum chỉ trả về {}.
Trong V8, việc sử dụng cùng một phương thức trên đối tượng enum sẽ trả về tên enum.
Khi di chuyển tập lệnh sang V8, hãy kiểm thử và điều chỉnh các kỳ vọng của mã về kết quả của JSON.stringify() trên các đối tượng enum:
// Rhino runtime var enumName = JSON.stringify(Charts.ChartType.BUBBLE); // enumName evaluates to {} |
// V8 runtime var enumName = JSON.stringify(Charts.ChartType.BUBBLE); // enumName evaluates to "BUBBLE" |
Điều chỉnh cách xử lý các tham số không xác định
Trong môi trường thời gian chạy Rhino ban đầu, việc truyền undefined vào một phương thức dưới dạng tham số dẫn đến việc truyền chuỗi "undefined" vào phương thức đó.
Trong V8, việc truyền undefined đến các phương thức tương đương với việc truyền null.
Khi di chuyển tập lệnh sang V8, hãy kiểm thử và điều chỉnh các kỳ vọng của mã về các tham số undefined:
// Rhino runtime SpreadsheetApp.getActiveRange() .setValue(undefined); // The active range now has the string // "undefined" as its value. |
// V8 runtime SpreadsheetApp.getActiveRange() .setValue(undefined); // The active range now has no content, as // setValue(null) removes content from // ranges. |
Điều chỉnh cách xử lý this toàn cục
Môi trường thời gian chạy Rhino xác định một ngữ cảnh đặc biệt ngầm ẩn cho các tập lệnh sử dụng môi trường đó.
Mã tập lệnh chạy trong ngữ cảnh ngầm ẩn này, khác với this toàn cục thực tế. Điều này có nghĩa là các tệp tham chiếu đến "this toàn cục" trong mã thực sự đánh giá theo ngữ cảnh đặc biệt, chỉ chứa mã và biến được xác định trong tập lệnh. Các dịch vụ Apps Script tích hợp sẵn và đối tượng ECMAScript sẽ không được sử dụng this theo cách này. Tình huống này tương tự như cấu trúc JavaScript sau:
// Rhino runtime // Apps Script built-in services defined here, in the actual global context. var SpreadsheetApp = { openById: function() { ... } getActive: function() { ... } // etc. }; function() { // Implicit special context; all your code goes here. If the global this // is referenced in your code, it only contains elements from this context. // Any global variables you defined. var x = 42; // Your script functions. function myFunction() { ... } // End of your code. }(); |
Trong V8, ngữ cảnh đặc biệt ngầm ẩn sẽ bị xoá. Các biến và hàm toàn cục được xác định trong tập lệnh được đặt trong ngữ cảnh toàn cục, bên cạnh các dịch vụ Apps Script tích hợp sẵn và ECMAScript tích hợp sẵn như Math và Date.
Khi di chuyển tập lệnh sang V8, hãy kiểm thử và điều chỉnh các kỳ vọng của mã về việc sử dụng this trong ngữ cảnh toàn cục. Trong hầu hết trường hợp, sự khác biệt chỉ rõ ràng nếu mã của bạn kiểm tra các khoá hoặc tên thuộc tính của đối tượng this toàn cục:
// Rhino runtime var myGlobal = 5; function myFunction() { // Only logs [myFunction, myGlobal]; console.log(Object.keys(this)); // Only logs [myFunction, myGlobal]; console.log( Object.getOwnPropertyNames(this)); } |
// V8 runtime var myGlobal = 5; function myFunction() { // Logs an array that includes the names // of Apps Script services // (CalendarApp, GmailApp, etc.) in // addition to myFunction and myGlobal. console.log(Object.keys(this)); // Logs an array that includes the same // values as above, and also includes // ECMAScript built-ins like Math, Date, // and Object. console.log( Object.getOwnPropertyNames(this)); } |
Điều chỉnh cách xử lý instanceof trong thư viện
Việc sử dụng instanceof trong thư viện trên một đối tượng được truyền dưới dạng tham số trong một hàm từ một dự án khác có thể dẫn đến kết quả âm tính giả. Trong môi trường thời gian chạy V8, một dự án và các thư viện của dự án đó sẽ chạy trong các ngữ cảnh thực thi khác nhau, do đó có các chuỗi nguyên mẫu và toàn cục khác nhau.
Xin lưu ý rằng đây chỉ là trường hợp nếu thư viện của bạn sử dụng instanceof trên một đối tượng không được tạo trong dự án. Việc sử dụng thuộc tính này trên một đối tượng được tạo trong dự án của bạn, cho dù trong cùng một tập lệnh hay một tập lệnh khác trong dự án, đều sẽ hoạt động như mong đợi.
Nếu một dự án đang chạy trên V8 sử dụng tập lệnh của bạn làm thư viện, hãy kiểm tra xem tập lệnh của bạn có sử dụng instanceof trên một tham số sẽ được truyền từ một dự án khác hay không. Điều chỉnh cách sử dụng instanceof và sử dụng các phương án thay thế khả thi khác theo trường hợp sử dụng của bạn.
Một giải pháp thay thế cho a instanceof b có thể là sử dụng hàm khởi tạo của a trong trường hợp bạn không cần tìm kiếm toàn bộ chuỗi nguyên mẫu mà chỉ cần kiểm tra hàm khởi tạo.
Cách sử dụng: a.constructor.name == "b"
Hãy xem xét Dự án A và Dự án B, trong đó Dự án A sử dụng Dự án B làm thư viện.
//Rhino runtime //Project A function caller() { var date = new Date(); // Returns true return B.callee(date); } //Project B function callee(date) { // Returns true return(date instanceof Date); } |
//V8 runtime //Project A function caller() { var date = new Date(); // Returns false return B.callee(date); } //Project B function callee(date) { // Incorrectly returns false return(date instanceof Date); // Consider using return (date.constructor.name == // “Date”) instead. // return (date.constructor.name == “Date”) -> Returns // true } |
Một giải pháp thay thế khác là giới thiệu một hàm kiểm tra instanceof trong dự án chính và truyền hàm đó cùng với các tham số khác khi gọi hàm thư viện. Sau đó, bạn có thể sử dụng hàm đã truyền để kiểm tra instanceof bên trong thư viện.
//V8 runtime //Project A function caller() { var date = new Date(); // Returns True return B.callee(date, date => date instanceof Date); } //Project B function callee(date, checkInstanceOf) { // Returns True return checkInstanceOf(date); } |
Điều chỉnh việc truyền tài nguyên không dùng chung đến thư viện
Việc truyền tài nguyên không dùng chung từ tập lệnh chính đến thư viện sẽ hoạt động theo cách khác trong môi trường thời gian chạy V8.
Trong môi trường thời gian chạy Rhino, việc truyền tài nguyên không dùng chung sẽ không hoạt động. Thay vào đó, thư viện sẽ sử dụng tài nguyên riêng.
Trong thời gian chạy V8, việc truyền tài nguyên không dùng chung vào thư viện sẽ hoạt động. Thư viện sử dụng tài nguyên không dùng chung đã truyền.
Không truyền tài nguyên không dùng chung dưới dạng tham số hàm. Luôn khai báo các tài nguyên không dùng chung trong cùng một tập lệnh sử dụng các tài nguyên đó.
Hãy xem xét Dự án A và Dự án B, trong đó Dự án A sử dụng Dự án B làm thư viện. Trong ví dụ này, PropertiesService là một tài nguyên không dùng chung.
// Rhino runtime // Project A function testPassingNonSharedProperties() { PropertiesService.getScriptProperties() .setProperty('project', 'Project-A'); B.setScriptProperties(); // Prints: Project-B Logger.log(B.getScriptProperties( PropertiesService, 'project')); } |
// V8 runtime // Project A function testPassingNonSharedProperties() { PropertiesService.getScriptProperties() .setProperty('project', 'Project-A'); B.setScriptProperties(); // Prints: Project-A Logger.log(B.getScriptProperties( PropertiesService, 'project')); } |
Cập nhật quyền truy cập vào tập lệnh độc lập
Đối với các tập lệnh độc lập chạy trên môi trường thời gian chạy V8, bạn cần cung cấp cho người dùng ít nhất là quyền xem tập lệnh để các trình kích hoạt của tập lệnh hoạt động đúng cách.