函数 修饰器¶
使用 修饰器 可以轻松改变函数的行为。 例如,它们可以在执行函数之前自动检查某个条件。 修饰器 是合约的可继承属性, 并可能被派生合约覆盖。
pragma solidity >=0.5.0 <0.7.0;
contract owned {
function owned() public { owner = msg.sender; }
address owner;
// 这个合约只定义一个修饰器,但并未使用: 它将会在派生合约中用到。
// 修饰器所修饰的函数体会被插入到特殊符号 _; 的位置。
// 这意味着如果是 owner 调用这个函数,则函数会被执行,否则会抛出异常。
modifier onlyOwner {
require(
msg.sender == owner,
"Only owner can call this function."
);
_;
}
}
contract mortal is owned {
// 这个合约从 `owned` 继承了 `onlyOwner` 修饰符,并将其应用于 `close` 函数,
// 只有在合约里保存的 owner 调用 `close` 函数,才会生效。
function close() public onlyOwner {
selfdestruct(owner);
}
}
contract priced {
// 修改器可以接收参数:
modifier costs(uint price) {
if (msg.value >= price) {
_;
}
}
}
contract Register is priced, owned {
mapping (address => bool) registeredAddresses;
uint price;
function Register(uint initialPrice) public { price = initialPrice; }
// 在这里也使用关键字 `payable` 非常重要,否则函数会自动拒绝所有发送给它的以太币。
function register() public payable costs(price) {
registeredAddresses[msg.sender] = true;
}
function changePrice(uint _price) public onlyOwner {
price = _price;
}
}
contract Mutex {
bool locked;
modifier noReentrancy() {
require(
!locked,
"Reentrant call."
);
locked = true;
_;
locked = false;
}
// 这个函数受互斥量保护,这意味着 `msg.sender.call` 中的重入调用不能再次调用 `f`。
// `return 7` 语句指定返回值为 7,但修改器中的语句 `locked = false` 仍会执行。
function f() public noReentrancy returns (uint) {
(bool success,) = msg.sender.call("");
require(success);
return 7;
}
}
如果同一个函数有多个 修饰器,它们之间以空格隔开,修饰器 会依次检查执行。
警告
在早期的 Solidity 版本中,有 修饰器 的函数,return
语句的行为表现不同。
修饰器 或函数体中显式的 return 语句仅仅跳出当前的 修饰器 和函数体。 返回变量会被赋值,但整个执行逻辑会从前一个 修饰器 中的定义的 “_” 之后继续执行。
修饰器 的参数可以是任意表达式,在此上下文中,所有在函数中可见的符号,在 修饰器 中均可见。 在 修饰器 中引入的符号在函数中不可见(可能被重载改变)。