L04b-4 函数:五段声明、可见性与 view / pure / payable
函数声明的固定五段,四种可见性各允许谁调用,view、pure、payable 向编译器承诺了什么,以及多返回值的写法。
一句话版
每个函数都要先写清楚三件事:谁能调它(可见性)、它会不会碰状态(view / pure)、能不能收钱(payable);编译器会逐行核对这些承诺,对不上就拒绝编译。
上一页 L04b-3 讲了调用者是谁,这一页讲被调的函数本身怎么声明。
先认识这几个词
| 词 | 白话意思 |
|---|---|
| 可见性 | 规定谁能调用这个函数 |
| 派生合约 | 继承了当前合约的子合约 |
| 状态 | 合约存在 storage 里的数据 |
| view | 承诺只读状态、不改 |
| pure | 承诺连状态都不读 |
| payable | 允许调用时附带 ether |
| getter | public 状态变量自动生成的读取函数 |
一个类比:办事大厅的窗口牌
每个函数像大厅里的一个窗口,门口挂着三块牌子。第一块写「对谁开放」:所有人、只对内部员工、连分公司也不行。第二块写「这个窗口只查询不办理」或者「只做计算不查档案」。第三块写「收费窗口」,只有挂了这块牌子的窗口才能收钱。
类比在哪里失效:
- 大厅的牌子挂错了没人管,Solidity 编译器会逐行检查函数体,承诺「只查询」却写了修改语句,直接编译失败。
- 「内部员工专用」的窗口外人看不到里面的档案,private 状态变量却任何人都能从链上读出来。
从零讲起
1. 函数声明的五段
它解决什么问题
合约函数会被陌生人调用、会动真钱。Solidity 要求把调用范围和行为承诺写进声明,让编译器和读代码的人一眼看清这个函数能做什么。
直觉
声明的顺序是固定的:先函数名和参数,再可见性,再行为修饰(pure / view / payable),然后是修饰器(如 onlyOwner),最后是 returns。花括号里的可见性必填,方括号里的其他段可选。
一步一步看
目标:把 withdraw 的函数声明拆成五段,看出哪一段必须写,哪几段可以省。
-
function withdraw(uint256 withdraw_amount):关键字、函数名、参数类型和名字。 -
public:可见性,四选一,必须写。 -
view/pure/payable:行为修饰,可选。 -
onlyOwner:修饰器,可选,可以挂多个。 -
returns (uint256):返回类型,可选。
怎么判断
拿到一行声明,先看可见性在不在:0.5.0 起不写就编译失败。再看行为修饰里有没有 constant:它作为函数修饰词在 0.5.0 被移除,功能由 view 取代,现在只能用来修饰状态变量常量。
常见误解
「函数不写可见性默认是 public」对吗?
那是 0.5.0 之前的口径。现在函数没有默认可见性,必须写。状态变量倒是有默认值,是 internal。
「修饰器要写在 returns 后面」对吗?
不对。按模板顺序,修饰器在行为修饰之后、returns 之前。
试一下
function f() constant returns (uint) 在 0.8 下能编译吗?
不能。缺可见性,而且 constant 已不能修饰函数,应写成 function f() public view returns (uint)。
2. 四种可见性
它解决什么问题
有的函数要给全世界调(如 withdraw),有的只是内部的计算步骤,暴露出去会被人乱调。可见性把这些分开。
直觉
从宽到窄排:public 谁都能调;external 只给外部调;internal 只给自己和子合约;private 只给自己。
一步一步看
目标:逐一对比四种可见性,看出外部账户、本合约和子合约分别能调哪几种函数。
-
public:外部账户、其他合约、本合约内部、子合约都能调。
-
external:外部能调;本合约内部要调必须写
this.f(),这会走一次真正的外部调用。 -
internal:外部调不到;本合约和子合约能调。
-
private:只有本合约能调,子合约也不行。
-
状态变量标 public 时,编译器自动生成同名 getter,外部可以读。
怎么判断
选可见性按两个问题:外部要不要直接调它?不要就在 internal 和 private 里选,子合约需要就 internal。要外部调,再问内部会不会调它:只给外部用就写 external,参数直接从 calldata 读,更省 gas;内外都用就写 public。
常见误解
「把密码存成 private 变量就安全了」对吗?
不对。private 只限制其他合约的代码访问它,链上存储本身对所有人公开,任何人都能用区块浏览器或读存储槽看到它的值。敏感数据不要放进合约。
「external 函数在合约内部完全调不了」对吗?
可以调,但必须写成 this.f(),相当于合约给自己发一次外部调用,要额外花 gas。
试一下
父合约里有一个 private 函数 _check(),子合约里调用 _check() 能编译吗?
不能。private 不被继承,子合约看不到它。改成 internal 才行。
3. view、pure、payable 与返回值
它解决什么问题
调用者需要知道一个函数会不会改链上数据、能不能收钱。行为修饰词把这个承诺写死,编译器替你检查。
直觉
三档递减:什么都不写,可读可写;view,只读不写;pure,不读不写,只用参数和常量。payable 是另一个维度,管能不能收 ether,不能和 view、pure 一起用。没标 payable 的函数收到带钱的调用会直接拒绝。
一步一步看
目标:先找出函数体里每一次读和写,再判断该标 view、pure、payable,还是什么都不加。
-
找出函数体里每一次读状态变量的地方。
-
找出每一次写状态变量的地方(赋值、push、发事件、转账都算写)。
-
既有写又有读:不加修饰。
-
只读:标 view。
-
都没有:标 pure。
-
需要收 ether:加 payable。
怎么判断
返回值有两种写法:在函数体里 return (a, b, c);,或者在 returns 里给返回变量起名,函数体直接给它们赋值。返回数组这类引用类型时,returns 里必须写数据位置,例如 uint256[3] memory。
数组字面量的类型按第一个元素推导,直接写 [1, 2, 5] 会被推成 uint8[3],所以要写成 [uint256(1), 2, 5]。
常见误解
「view 函数永远不花 gas」对吗?
只对一半。从链下直接调用时,节点本地执行后返回,不发交易、不花 gas;在一笔交易里被别的函数调用时,照样算 gas。
「pure 函数可以读 constant 常量」对吗?
可以。constant 在编译期就确定,不占存储,读它不算读状态。课件里的 getDefaultChoice 就是这样。
试一下
function setChoice(ActionChoices c) public view { choice = c; } 能编译吗?
不能。函数体给状态变量赋值,违反了 view 的承诺。去掉 view 即可。
把它们串起来
函数声明的五段里,可见性回答「谁能调」,行为修饰回答「会不会碰状态、能不能收钱」,returns 回答「给回什么」。这三类信息都是写给编译器的承诺,编译器逐行核对函数体,任何一处读写超出承诺就拒绝编译。
可见性和数据位置也有关联:external 的参数直接从 calldata 读,public 因为要支持内部调用,参数需要拷贝进 memory。只给外部用的函数写 external,既表达了意图,又省 gas。
课件里的坑
- [前后矛盾] 一页说可见性必须显式声明,另一页的表格写「public 是默认」。以前者为准:函数自 0.5.0 起没有默认可见性;状态变量的默认可见性是 internal(p.28、p.33)
- [过时语法] 语法模板把
constant当函数修饰词,它在 0.5.0 被移除、由 view 取代(p.27、p.33、p.34) - [容易误解] 课件说 private 不能被其他合约访问,没提醒链上数据对所有人可读(p.33)
课后 10 分钟:考点复习
这 10 分钟怎么用:先默写五段模板和可见性四行表;再拿课件的 Faucet 逐个函数说出可见性和行为修饰;最后做完整例题,练「先标读写,再比承诺」的判断方法。
必背
- 函数声明五段式:function 名字(参数) 可见性 状态可变性 returns(返回类型);四种可见性 public / external / internal / private 自 0.5.0 起必须显式写出,没有默认值;view 只读、pure 连读都不读、payable 才能收 ETH。
- 函数没有默认可见性,状态变量的默认可见性是 internal。
- external 只能从外部调用,合约内部要加 this. 前缀;它的参数直接从 calldata 读,比 public 更省 gas。
- private 只限制其他合约的代码访问,链上存储对所有人公开可读,private 不等于保密。
- view 和 pure 从外部调用时不发交易、不花 gas,从合约内部调用时照样在交易里花 gas。
课件例题
例 1(课件 p.35):加了 pure 还能编译吗:见下方完整例题。
提示
把 number = number + 1 拆成一次读、一次写,再分别和 pure、view 的承诺比较。
解答
加 pure 的那段不能编译,换成 view 也不能;不加修饰的那段能编译,每调一次 number 加 1。逐步推理见完整例题。
例 2(课件 p.36):两个函数返回什么
题面:读下面两个函数,写出各自的返回值;uint256[3] memory 里的 memory 能不能省?为什么第一个元素要写成 uint256(1)?
function returnMultiple() public pure returns (uint256, bool, uint256[3] memory) {
return (1, true, [uint256(1), 2, 5]);
}
function returnNamed() public pure returns (uint256 _number, bool _bool, uint256[3] memory _array) {
_number = 2;
_bool = false;
_array = [uint256(3), 2, 1];
}
提示
第一个函数看 return 语句,第二个函数看给命名返回变量的赋值。memory 的问题回到上一页的数据位置规则。
解答
returnMultiple()返回(1, true, [1, 2, 5]),用的是函数体里的return。returnNamed()返回(2, false, [3, 2, 1])。它在returns里给返回变量起了名,函数体直接赋值,不用写return。memory不能省:返回的是定长数组,属于引用类型,必须写数据位置。- 数组字面量的类型由第一个元素推导,直接写
1会被推成uint8,整个数组变成uint8[3],和声明的uint256[3]对不上,所以要显式转换第一个元素。
完整例题
题面(课件 p.35):课件并排放了两段代码,右边打了一个大红问号。左边是 function add() external { number = number + 1; },右边在同一位置多了一个 pure。number 是状态变量 uint256 public number = 5;。问:(a) 哪一段能编译?(b) 把右边的 pure 换成 view 呢?(c) 左边那段每调用一次 add(),number 怎么变?
pragma solidity ^0.8.21;
contract FunctionTypes {
uint256 public number = 5;
function add() pure external { // 右边那段:多了 pure
number = number + 1;
}
}
- 先拆这行语句做了什么:
number = number + 1先读状态变量number,再把结果写回去。一行里同时有读和写。 - 对照三档承诺:
pure承诺既不读也不写状态;view承诺只读不写;什么都不写则读写都允许。 - (a) 右边:
pure被读和写两件事同时违反,编译器直接报错,大意是「函数声明为 pure,但这条语句读取或修改了状态」。右边不能编译,左边能。 - 左边为什么能:没有任何可变性修饰词,默认可以改状态;
external也合法,因为没有在合约内部调用它。 - (b) 换成
view:读这一步过了,写这一步没过,view不允许赋值给状态变量。仍然不能编译。 - (c)
number初值是 5。左边的add()每成功调用一次加 1:第一次之后是 6,第二次之后是 7。number标了public,编译器自动生成同名的读取函数,在 Remix 里点number就能看到当前值。 - 这道题考的是什么:可变性修饰词是写给编译器的承诺,编译器会逐行核对。判断时先找出语句里每一次读状态、写状态,再拿去和承诺比,比不过就是编译错误,不会等到运行时才出事。
答题格式:先写「这行语句读了 X、写了 X」,再逐个修饰词判断「承诺 → 是否违反 → 能否编译」。
变式题(先自己做)
自编情境:合约里有状态变量 uint256 public total;。下面三个函数各该标 view、pure 还是什么都不标,才能编译且承诺最严?(1) function double(uint256 x) public ... returns (uint256) { return x * 2; };(2) function getTotal() public ... returns (uint256) { return total; };(3) function deposit() public ... { total += msg.value; }
提示
照完整例题第 1 步,把每个函数体里的读状态和写状态逐一标出来。第三问还要想:msg.value 不为零时,函数缺了哪个修饰词就会拒收?
判分点与答案(非官方评分标准)
判分点:① 「最严」指能编译的前提下承诺最多;② 第三问要同时答出可变性和能不能收钱;③ 只读参数不算读状态。
(1) 只用参数做计算,不读不写状态,标 pure。
(2) 读了状态变量 total,没写,标 view;标 pure 会编译失败。
(3) total += msg.value 读了又写,不能标 view 或 pure;它还要收 ETH,没有 payable 会被拒收,所以写成 public payable。
闪卡自测
1. public 和 external 的区别在哪?
public 合约内外都能直接调;external 只能从外部调,本合约内部要调必须写 this.f(),那会走一次真正的外部调用、额外花 gas。好处是 external 的参数可以直接从 calldata 读,更省(p.33)。
2. 为什么 private 变量并不保密?
private 限制的是其他合约的代码能不能访问它,链上存储本身对所有人公开可读。不要把任何敏感数据放进合约,无论标什么可见性(p.33)。
3. view 和 pure 差在哪?
view 承诺不修改状态,但可以读状态变量;pure 承诺连读都不读,只用参数、常量和纯计算。两者从链下直接调用时都不花 gas,在交易里被调用时照样算 gas(p.34)。
4. 没标 payable 的函数收到带 ether 的调用会怎样?
拒绝,整笔调用回滚(p.34)。
5. 状态变量不写可见性,默认是什么?
internal。函数没有默认可见性,必须写(p.28)。
下一讲
下一页 L04b-5 讲三件让合约「对外说话」的机制:没匹配到函数的调用和纯转账由 receive、fallback 接住;出错时用 require、revert、assert 整笔回滚;成功时用事件把消息递给链下。
个人整理的学习笔记,不是官方材料;数字与结论以课件和讲师为准。