Solidity 修饰器

Solidity 的修饰器是一种特殊的函数，它可以被用来修饰，改变函数的行为，修饰器可以在函数执行前进行预处理和验证操作。例如可以验证函数入参是否符合预期，或者验证调用者是否具有特定权限。使用修饰器能提高代码复用和可读性。

例如下面的示例中，有几个函数（mint, changeOwner, pause）要求调用者是 owner 时才能正常调用。每个函数执行前我们都需要使用 require(msg.sender == owner, ...) 对调用者身份进行检查。而这部分的逻辑是重复的。良好的代码设计都会希望将重复的代码抽取出来成为一个函数。我们当然也希望可以这么做。

用 require 来进行权限检查

pragma solidity ^0.8.17;

contract ExampleContract {
    address private owner;

    constructor() {
        owner = msg.sender;
    }

    function mint() external {
        require(msg.sender == owner, "Only the owner can call this function.");
        // Function code goes here
    }

    function changeOwner() external {
        require(msg.sender == owner, "Only the owner can call this function.");
        // Function code goes here
    }

    function pause() external {
        require(msg.sender == owner, "Only the owner can call this function.");
        // Function code goes here
    }
}

试一试 »

在这种情况下，我们可以把权限检查的代码抽出来，变成一个修饰器。如果有函数需要权限检查时就可以添加这个修饰器去修饰函数行为。如下面所示：

用修饰器来进行权限检查

pragma solidity ^0.8.17;

contract ExampleContract {
    address private owner;

    constructor() {
        owner = msg.sender;
    }

    // 将权限检查抽取出来成为一个修饰器
    modifier onlyOwner() {
        require(msg.sender == owner, "Only the owner can call this function.");
        _;
    }

    // 添加 onlyOwner 修饰器来对调用者进行限制
    // 只有 owner 才有权限调用这个函数
    function mint() external onlyOwner { 
        // Function code goes here
    }

    // 添加 onlyOwner 修饰器来对调用者进行限制
    // 只有 owner 才有权限调用这个函数
    function changeOwner() external onlyOwner {
        // Function code goes here
    }

    // 添加 onlyOwner 修饰器来对调用者进行限制
    // 只有 owner 才有权限调用这个函数
    function pause() external onlyOwner {
        // Function code goes here
    }
}

试一试 »

像上面所展示的一样，有了修饰器，你就不需要写重复的代码了。提高了代码复用，降低了出现 bug 的可能性。

修饰器的语法

根据上面的例子，我们不难看出定义修饰器的语法。如下所示：

modifier modifierName {
    // modifier body 1
    _;
    // modifier body 2
}

定义修饰器的语法是比较简单明了的，其中要注意 _ 是一个占位符（placeholder），代表的是函数主体（function body）。你可以认为函数主体被移动到 _ 所在的位置。按照上面的定义，其执行顺序为：

执行 modifier body 1
执行函数主体
执行 modifier body 2

定义完修饰器后你就可以在函数中使用它。修饰器是跟在函数参数列表后面的。

添加修饰器

添加单个修饰器

function foo() public modifier1 {
    // function body
}

添加多个修饰器，它们的执行顺序是从左到右的

function foo() public modifier1, modifier2, modifier3 {
    // function body
}

Solidity 修饰器

修饰器的语法​

修饰器的语法