智能合约与以太坊 / 系统课时

设置函数可见性与读写属性

设置函数可见性与读写属性

同一份 Solidity 合约,既要允许钱包查询状态,也要限制哪些函数可从外部调用,还要明确哪些操作能修改链上状态。本课用一个可部署的计数与收款合约,分别验证四种可见性和三种状态修饰符的实际效果。

学习目标

  • 判断 public、external、internal、private 各自允许的调用位置。
  • 区分 view、pure、payable 与默认非支付函数的行为。
  • 在 Remix 中执行读写、继承调用和携带 ETH 的交易,并核对状态变化。

用可见性划定调用范围

函数可见性写在参数列表之后,控制编译期能从哪里引用该函数。外部账户通过交易调用合约时,只能访问 ABI 中公开的 public 或 external 函数。

可见性 合约内部直接调用 子合约直接调用 其他合约或钱包调用
public 可以 可以 可以
external 不可以,须用 this.f() 不可以直接调用,可经外部接口调用 可以
internal 可以 可以 不可以
private 可以 不可以 不可以

this.f() 会发起一次对本合约地址的外部调用,不等同于内部的 f():它有额外调用开销,且被调用函数看到的 msg.sender 是合约自身。不要为了复用逻辑而频繁这样调用。

四种函数可见性在本合约、派生合约和外部调用者之间的访问范围

用状态修饰符约束读写

可见性回答“谁能调用”,状态可变性回答“函数能做什么”。两类标记可以组合,例如 external view、public pure 和 external payable。

声明 允许读取链上状态 允许修改链上状态 可随调用接收 ETH
view 是 否 否
pure 否 否 否
payable 是 是 是
不写上述修饰符(默认 nonpayable) 是 是 否

view 可读取存储变量,但不能改写变量或发送事件;pure 只能处理输入和局部计算,不能读取存储变量、block.timestamp 等链上上下文。payable 允许接收 msg.value,并不表示收到的 ETH 会自动记到业务账本;记账逻辑需要自己实现。payable 不能与 view 或 pure 同时声明。

编写可编译的完整合约

打开 Remix(https://remix.ethereum.org),创建 VisibilityVault.sol,使用 Solidity 0.8.20 或兼容的更新 0.8.x 编译器。下面的两个合约分别验证同一合约内的调用和派生合约对 internal 函数的访问。

solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

contract VisibilityVault {
    uint256 private counter = 10;
    uint256 public totalDeposited;

    function read() public view returns (uint256) {
        return counter;
    }

    function readExternal() external view returns (uint256) {
        return counter;
    }

    function twice(uint256 value) public pure returns (uint256) {
        return value * 2;
    }

    function _increase() internal {
        counter += 1;
    }

    function increase() public {
        _increase(); // 内部调用,不产生外部消息调用
    }

    function _seed() private pure returns (uint256) {
        return 3;
    }

    function addSeed() external {
        counter += _seed(); // private 只在定义它的合约中调用
    }

    function readViaThis() external view returns (uint256) {
        return this.readExternal(); // 必须经外部消息调用
    }

    function deposit() external payable {
        totalDeposited += msg.value;
    }
}

contract VaultChild is VisibilityVault {
    function increaseFromChild() external {
        _increase(); // 子合约可以访问继承的 internal 函数
    }
}

预期结果:编译成功并显示 VisibilityVault、VaultChild 两个可部署合约。部署一个 VisibilityVault 实例后,调用 read() 返回 10,调用自动生成的 totalDeposited() 返回 0。counter 没有外部自动 getter,因为它声明为 private。

在 Remix 核对返回值与状态变化

  1. 打开左侧 Solidity Compiler,选择兼容的 0.8.x 编译器并点击 Compile VisibilityVault.sol。
  2. 打开 Deploy & Run Transactions,环境选 Remix VM,合约选 VisibilityVault,点击 Deploy。展开已部署实例。
  3. 依次调用下表中的方法。除收款步骤外,保持 Value = 0;调用 deposit() 前将 Value 设为 1000、单位选 Wei,执行后再恢复为 0。
调用顺序 期望结果
read() 返回 10
twice(7) 返回 14,read() 仍为 10
increase(),然后 read() 返回 11
addSeed(),然后 readViaThis() 返回 14
deposit(),Value = 1000 Wei 交易成功,totalDeposited() 返回 1000
再调用 readExternal() 返回 14,收款不改变计数器

接着单独部署 VaultChild:先调用继承的 read(),应返回 10;调用 increaseFromChild() 后再读,应返回 11。两个部署实例各有自己的存储,子合约实例的调用不会更改刚才 VisibilityVault 实例的 counter。

识别编译限制与交易边界

把 readExternal() 在合约内部写成裸调用 readExternal() 会编译失败,应改为 this.readExternal();若想避免外部调用开销,应提取 internal 公共逻辑。子合约直接调用 _seed() 也会编译失败,因为 private 不可被子合约引用。

尝试给 view 函数增加 counter += 1,或让 pure 函数返回 counter,会受到编译器状态可变性检查。向 increase() 附带 1 Wei 则会因非 payable 而回退;向 deposit() 附带 1000 Wei 可成功。

通过 Remix 的直接读取通常使用本地只读调用,不需要发送交易;但若通过交易执行 view 或 pure 函数,仍会消耗 Gas。示例 deposit() 只累计收款,没有提款入口,因此仅在 Remix VM 使用测试资产验证,不要在真实网络向它转账。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

设置函数可见性与读写属性

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通