JavaScript基礎系列之函數(shù)和方法詳解
一、函數(shù)和方法的區(qū)別
- 函數(shù)（function）：函數(shù)是帶有名稱和參數(shù)的 JavaScript 代碼段，可以一次定義多次調用。
- 方法（method）：當將函數(shù)和對象寫在一起時，函數(shù)就變成了“方法”，比如當函數(shù)賦值給對象的屬性時，我們便稱其為“方法”。
二、如何寫好一個函數(shù)
在 JS 中，除了變量，用的最多的應該就是函數(shù)了，函數(shù)是 Javascript 的第一公民。
2.1 命名準確
2.1.1 函數(shù)命名
函數(shù)的命名需要明確，語義清晰，簡單概括函數(shù)的功能。我們不要想著代碼簡短而縮短函數(shù)名稱，這并不會提高什么性能或效率，相反，一個函數(shù)名稱若不夠清晰，往往其他人無法理解。
盡量使用動詞，比如：getXxxxx、setXxxxx，動詞在前面，語義就能更加清晰。
2.1.2 參數(shù)命名
強調語義化，參數(shù)命名讓調用者更清晰的知道該傳入什么，對應什么參數(shù)。當然，像一些通用命名還是可接受的，像 callback，fn，即使不看注釋，往往我也知道這里的參數(shù)要做什么，傳什么。
2.2 函數(shù)注釋
/**
* 時間格式化工具函數(shù)
*
* @param { (Date | number) } date - 時間
* @param { string } unit - 轉換格式
*/
export const timeFormat = (date: Date ｜ number | string, unit: string) => {
if (!date) {
return ''
}
if (typeof date === 'string') return date;
if (typeof date === 'number') {
date = new Date(date);
}
const year = date.getFullYear();
const month = date.getMonth() + 1;
const day = date.getDate();
const hour = date.getHours();
const minute = date.getMinutes();
const second = date.getSeconds();
if (unit === 'year') return `${year}`;
if (unit === 'month') return `${year}-${month}`;
if (unit === 'day') return `${year}-${month}-${day}`;
if (unit === 'hour') return `${year}-${month}-${day} ${hour}`;
if (unit === 'minute') return `${year}-${month}-${day} ${hour}:${minute}`;
if (unit === 'second') return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
}
2.2.1 參數(shù)注釋
/**
* 時間格式化工具函數(shù)
*
* @param { (Date | number) } date - 時間
* @param { string } unit - 轉換格式
*/
@param { type } 參數(shù) - 參數(shù)解釋：type 表明的是參數(shù)的類型，比如 string，number，當有多個參數(shù)類型的時候，可以這么來標識 { (string|string[]) }，表示這個參數(shù)可以是字符串或者字符串數(shù)組。
對象屬性：需要解釋對象的每一個屬性
/**
* 將項目分配給員工的函數(shù)
*
* @param {Object} employee - 項目員工
* @param {string} employee.name - 項目員工的姓名
* @param {string} employee.department - 項目員工的部門
*/
Project.prototype.assign = function(employee) {
// ...
};
可選參數(shù)：
/**
* 時間格式化工具函數(shù)
*
* @param { (Date | number | string) } date - 時間
* @param { string } [unit] - 轉換格式
*/
export const timeFormat = (date: Date ｜ number | string, unit: string) => {
// ...
}
默認值：
/**
* 時間格式化工具函數(shù)
*
* @param { (Date | number) } date - 時間
* @param { string } [unit = 'second'] - 轉換格式
*/
export const timeFormat = (date: Date ｜ number | string, unit = 'second') => {
// ...
}
2.3 函數(shù)參數(shù)
2.3.1 參數(shù)默認值
export const timeFormat = (date: Date, unit = 'second') => {
// ...
}
2.3.2 對象參數(shù)
async function printer_proxy_print(
html_str: string,
file_path: string,
device: string | undefined,
orientation: number,
printer_mode: string,
width: number,
height: number,
scale: number,
from: number,
to: number,
left_offset: number,
top_offset: number,
pdf_tools: string | undefined,
begin_page = 1,
end_page = 1,
repeat_times = 1,
print_type: string
) {
// ...
}
可以給參數(shù)默認值，這樣可以只傳前面幾個必要的參數(shù)，像這樣調用。
async function printer_proxy_print(
html_str: string,
file_path: string,
device = 'pc',
orientation = 'xxx',
printer_mode = 'xxx',
width = 123,
height = 123,
scale = 123,
from = 123,
to = 123,
left_offset = 123,
top_offset = 123,
pdf_tools = 123,
begin_page = 1,
end_page = 1,
repeat_times = 1,
print_type = 'base64'
) {
// ...
}
await printer_proxy_print(html_str, file_path);
上面的方法看似可行，實際上，當我中間某個參數(shù)不一樣的時候，我就需要把這個參數(shù)前面的參數(shù)都傳一遍。這樣顯然不可行。所以當參數(shù)多的時候，我們需要用對象解構的方式傳參。
async function printer_proxy_print({
html_str,
file_path,
device = 'pc',
orientation = 'xxx',
printer_mode = 'xxx',
width = 123,
height = 123,
scale = 123,
from = 123,
to = 123,
left_offset = 123,
top_offset = 123,
pdf_tools = 123,
begin_page = 1,
end_page = 1,
repeat_times = 1,
print_type = 'base64'
}) {
// ...
}
await printer_proxy_print({html_str, file_path});
解構的好處便是我可以隨便傳我想要的某幾個參數(shù)，而不用在意順序問題。不過像這么多參數(shù)的函數(shù)往往存在問題（具體問題具體分析）。也就是下面提到的參數(shù)數(shù)量問題。
2.3.3 參數(shù)數(shù)量
一個函數(shù)的參數(shù)越少越好，最多不應該超過3個，參數(shù)多往往意味著關系多，邏輯交叉相對也就多了起來。在進行測試的時候，往往也就很難覆蓋到所有條件，出問題概率也就加大了。
參數(shù)多的時候，有時候也意味著功能多，就違背了 單一功能 的原則。
2.3.4 參數(shù)類型防御
在 TS 開發(fā)前，我們不知道用戶會傳什么東西進來，這時候往往容易產(chǎn)生類型錯誤，又或者，我們想實現(xiàn)兼容，像前面的 timeFormat 函數(shù)，我們希望用戶調用的時候，可以是想對 時間對象 格式化，也可以是對 時間戳 格式化，那我們就需要做一個防御處理。
if (!date) {
return ''
}
if (typeof date === 'string') return date;
if (typeof date === 'number') {
date = new Date(date);
}
不過值得注意的是，即使我們用上了 TS，在大多數(shù)情況下，我們確實可以避免參數(shù)類型問題，但是這并不絕對，因為我們有時候會直接接受 接口 返回的數(shù)據(jù)。
我們常說，永遠不要相信用戶的輸入，同樣，接口返回的數(shù)據(jù)我也不信，我們不能保證，后端不會出錯，約定好的參數(shù)是數(shù)組類型，怎么空的時候，你給我個 null 呢？
當然這些情況有時候需要去試錯，有時候我們能想到的可能，不要偷懶，給寫上類型判斷吧。
2.4 函數(shù)的返回
2.4.1 冪等函數(shù)
什么叫冪等，簡單來說，輸入什么輸出什么是固定的，入?yún)Q定了出參，不管調用多少次，只要輸入一樣，結果應該保持一樣。
function sum(a: number, b: number) {
return a + b;
}
冪等函數(shù)具有可維護性，相對容易進行單元測試。
2.4.2 純函數(shù)
純函數(shù)在冪等的條件下，還要求沒有副作用。
const dog = {
name: 'puppy',
age: 2,
weight: 30,
}
if (!dog.color) {
console.log('has no color');
}
function addColor(dog) {
dog.color = 'white';
}
addColor(dog);
console.log(dog); // {name: "puppy", age: 2, weight: 30, color: "white"}
可以看到，addColor 函數(shù)修改了 dog 對象的屬性，也就是產(chǎn)生了副作用。
function addColor(dog) {
let copyDog = Object.assign({}, dog);
copyDog.color = 'white';
return copyDog;
}
這樣一來，dog 對象的屬性就不會修改，addColor 函數(shù)是純函數(shù)。
2.4.3 return null
null 在進行處理的時候相對麻煩，需要進行判斷，導致了額外的代碼，應當返回空對象，或者是空數(shù)組，或者拋出異常。
函數(shù)和方法的區(qū)別
1）函數(shù)（function）是一段代碼，通過名字來進行調用。它能將一些數(shù)據(jù)（參數(shù)）傳遞進去進行處理，然后返回一些數(shù)據(jù)（返回值），也可以沒有返回值。
2）方法（method）是通過對象調用的javascript函數(shù)。也就是說，方法也是函數(shù)，只是比較特殊的函數(shù)。他是和一個對象相關聯(lián)。假設有一個函數(shù)是fn，一個對象是obj，那么就可以定義一個method：
obj.method = fn;
obj.method();
3）函數(shù)的數(shù)據(jù)是顯式傳遞
4）方法中的數(shù)據(jù)是隱式傳遞的；方法和對象相關。
總結
到此這篇關于JavaScript基礎系列之函數(shù)和方法的文章就介紹到這了,更多相關JavaScript函數(shù)和方法內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
js采用map取到id集合組并且實現(xiàn)點擊一行選中一行
本文為大家介紹下如何使用js采用map取到id集合組,并且點擊一行選中一行2013-12-12
這篇文章主要介紹了微信小程序學習筆記之登錄API與獲取用戶信息操作,結合實例形式分析了微信小程序登陸請求及后臺交互相關操作技巧,并結合圖文形式進行說明,需要的朋友可以參考下2019-03-03
下面小編就為大家?guī)硪黄獪\談在js傳遞參數(shù)中含加號(+)的處理方式。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-10-10
這篇文章主要介紹了JS實現(xiàn)div模塊的截圖并下載功能,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2017-10-10
了解JavaScript的人都知道JavaScript的this不總是指向當前對象，函數(shù)或類中的this指向與調用這個函數(shù)的對象以及上下文環(huán)境是息息相關的。2010-02-02
JavaScript實現(xiàn)LRU緩存淘汰算法的詳細步驟
這篇文章主要介紹了JavaScript實現(xiàn)LRU緩存淘汰算法,下面是用 JavaScript 實現(xiàn) LRU（Least RecentlyUsed,最近最少使用）緩存淘汰算法的代碼,并附上詳細的步驟解釋,需要的朋友可以參考下2024-12-12
拖動Html元素集合 Drag and Drop any item
拖動Html元素集合 Drag and Drop any item...2006-12-12
JavaScript函數(shù)及其prototype詳解
這篇文章主要介紹了JavaScript函數(shù)及其prototype詳解的相關資料,需要的朋友可以參考下2023-03-03
這篇文章主要介紹了CocosCreator入門教程之用TS制作第一個游戲，對TypeScript感興趣的同學，一定要看一下2021-04-04
詳解JavaScript中new操作符的解析和實現(xiàn)
這篇文章主要介紹了JavaScript中new操作符的解析和實現(xiàn)，幫助大家更好的理解和學習JavaScript，感興趣的朋友可以了解下2020-09-09