class-methods-use-this

强制类方法使用 this

类通常用于将可重用的逻辑，特别是有状态的逻辑，封装到对象中，其中每个实例的状态通过 this 访问。当 API 使用实例方法编写时，它向使用者传达了以下信息：

该方法的结果与其被调用的对象相关，包括可能的对象状态。

const array1 = [1, 2, 3];
const array2 = [4, 5, 6];

// Using the `includes()` method on different objects gives different results:
array1.includes(1); // true
array2.includes(1); // false

// Modifying the state of an object may change the outcome of its instance methods:
array2.push(1);
array2.includes(1); // true
1
2
3
4
5
6
7
8
9
10

这个方法在没有相关对象的情况下使用是没有意义的。（例如，在没有要操作的数组的情况下调用 Array#includes() 是没有意义的。）

可以有一个不使用 this 的类方法，例如：

🌐 It’s possible to have a class method which doesn’t use this, such as:

class Person {
    sayHi() {
        console.log("Hi!");
    }
}

const person = new Person();
person.sayHi(); // => "Hi!"
1
2
3
4
5
6
7
8

如果一个类的实例方法不使用 this，通常意味着它不访问任何实例状态，因此不需要成为一个方法。因此，它有时可以被重构为一个普通函数或一个静态方法，这可能更好地向 API 的使用者传达意图。

🌐 If a class instance method does not use this, that normally means that it does not access any instance state and therefore doesn’t need to be a method. Therefore, it can sometimes be refactored into an ordinary function or a static method, which may better communicate intent to users of the API.

在上面的例子中，sayHi 方法没有使用 this，所以我们可以把它做成一个普通函数：

🌐 In the example above, the sayHi method doesn’t use this, so we can make it an ordinary function:

// Ordinary function
function sayHi() {
	console.log("Hi!");
}

// No need for `Person` class or any instance thereof
sayHi(); // => "Hi!"

// Alternately, a static method may be used if it offers a more natural API
class Person {
    static sayHi() {
        console.log("Hi!");
    }
}

Person.sayHi(); // => "Hi!"

// Keep in mind that, either way, the following now throws an error,
// since sayHi() is no longer an instance method!
//
// const person = new Person();
// person.sayHi();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

也有可能作者忘记使用他们本打算包含的某些实例数据。

🌐 It’s also possible the author forgot to use some piece of instance data that they intended to include.

class Person {
	constructor(name) {
		this.name = name;
	}

	sayHi() {
		console.log(`Hi from ${this.name}!`);
	}
}

const alice = new Person('Alice');
alice.sayHi(); // => 'Hi from Alice!'

const bob = new Person('Bob');
bob.sayHi(); // => 'Hi from Bob!'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

规则详情

🌐 Rule Details

此规则标记未使用 this 的类实例方法。

🌐 This rule flags class instance methods that do not use this.

此规则的错误代码示例：

🌐 Examples of incorrect code for this rule:

class-methods-use-this

规则详情

选项

exceptMethods

enforceForClassFields

ignoreOverrideMethods

ignoreClassesWithImplements

何时不使用

版本

进阶读物

资源