【从0学习Solidity】 3. 函数详解

【从0学习Solidity】 3. 函数详解_区块链

  • 博主简介:不写代码没饭吃,一名全栈领域的创作者,专注于研究互联网产品的解决方案和技术。熟悉云原生、微服务架构,分享一些项目实战经验以及前沿技术的见解。
  • 关注我们的主页,探索全栈开发,期待与您一起在移动开发的世界中,不断进步和创造!
  • 本文收录于 不写代码没饭吃 的学习汇报系列,大家有兴趣的可以看一看。
  • 欢迎访问我们的微信公众号:不写代码没饭吃,获取更多精彩内容、实用技巧、行业资讯等。您关注的是我们前进的动力!

函数

Solidity语言的函数非常灵活,可以进行各种复杂操作。在本教程中,我们将会概述函数的基础概念,并通过一些示例演示如何使用函数。

我们先看一下 Solidity 中函数的形式:

function <function name>(<parameter types>) {internal|external|public|private} [pure|view|payable] [returns (<return types>)]

看着有一些复杂,让我们从前往后逐个解释(方括号中的是可写可不
写的关键字):

  1. function:声明函数时的固定用法。要编写函数,就需要以 function 关键字开头。
  2. <function name>:函数名。
  3. (<parameter types>):圆括号内写入函数的参数,即输入到函数的变量类型和名称。
  4. {internal|external|public|private}:函数可见性说明符,共有4种。
  • public:内部和外部均可见。
  • private:只能从本合约内部访问,继承的合约也不能使用。
  • external:只能从合约外部访问(但内部可以通过 this.f() 来调用,f是函数名)。
  • internal: 只能从合约内部访问,继承的合约可以用。

注意 1:合约中定义的函数需要明确指定可见性,它们没有默认值。

注意 2public|private|internal 也可用于修饰状态变量。public变量会自动生成同名的getter函数,用于查询数值。未标明可见性类型的状态变量,默认为internal

  1. [pure|view|payable]:决定函数权限/功能的关键字。payable(可支付的)很好理解,带着它的函数,运行的时候可以给合约转入 ETH。pureview 的介绍见下一节。
  2. [returns ()]:函数返回的变量类型和名称。

到底什么是 PureView

刚开始学习 solidity 时,pureview 关键字可能令人费解,因为其他编程语言中没有类似的关键字。solidity 引入这两个关键字主要是因为 交易需要支付气费(gas fee)。合约的状态变量存储在链上,gas fee 很贵,如果计算不改变链上状态,就可以不用付 gas。包含 pureview 关键字的函数是不改写链上状态的,因此用户直接调用它们是不需要付 gas 的(注意,合约中非 pure/view 函数调用 pure/view 函数时需要付gas)。

在中,以下语句被视为修改链上状态:

  1. 写入状态变量。
  2. 释放事件。
  3. 创建其他合约。
  4. 使用 selfdestruct.
  5. 通过调用发送。
  6. 调用任何未标记 viewpure 的函数。
  7. 使用低级调用(low-level calls)。
  8. 使用包含某些操作码的内联汇编。

为了帮助大家理解,我画了一个马里奥插图。在这幅插图中,我将合约中的状态变量(存储在链上)比作碧琪公主,三种不同的角色代表不同的关键字。

【从0学习Solidity】 3. 函数详解_区块链_02

  • pure,中文意思是“纯”,这里可以理解为”纯打酱油的”。pure 函数既不能读取也不能写入链上的状态变量。就像小怪一样,看不到也摸不到碧琪公主。
  • view,“看”,这里可以理解为“看客”。view函数能读取但也不能写入状态变量。类似马里奥,能看到碧琪公主,但终究是看客,不能入洞房。
  • pureview 的函数既可以读取也可以写入状态变量。类似马里奥里的 boss,可以对碧琪公主为所欲为🐶。

代码

1. pure 和 view

我们在合约里定义一个状态变量 number,初始化为 5。

// SPDX-License-Identifier: MIT
    pragma solidity ^0.8.4;
    contract FunctionTypes{
        uint256 public number = 5;
    }

定义一个 add() 函数,每次调用会让 number 增加 1。

// 默认
    function add() external{
        number = number + 1;
    }

如果 add() 函数被标记为 pure,比如 function add() pure external,就会报错。因为 pure 是不配读取合约里的状态变量的,更不配改写。那 pure 函数能做些什么?举个例子,你可以给函数传递一个参数 _number,然后让他返回 _number + 1,这个操作不会读取或写入状态变量。

// pure:
    function addPure(uint256 _number) external pure returns(uint256 new_number){
        new_number = _number + 1;
    }

【从0学习Solidity】 3. 函数详解_可见性_03

如果 add() 函数被标记为 view,比如 function add() view external,也会报错。因为 view 能读取,但不能够改写状态变量。我们可以稍微改写下函数,读取但是不改写 number,返回一个新的变量。

// view: 看客
    function addView() external view returns(uint256 new_number) {
        new_number = number + 1;
    }

【从0学习Solidity】 3. 函数详解_可见性_04

2. internal v.s. external

// internal: 内部函数
    function minus() internal {
        number = number - 1;
    }

    // 合约内的函数可以调用内部函数
    function minusCall() external {
        minus();
    }

我们定义一个 internalminus() 函数,每次调用使得 number 变量减少 1。由于 internal 函数只能由合约内部调用,我们必须再定义一个 externalminusCall() 函数,通过它间接调用内部的 minus() 函数。

【从0学习Solidity】 3. 函数详解_区块链_05

3. payable

// payable: 递钱,能给合约支付eth的函数
    function minusPayable() external payable returns(uint256 balance) {
        minus();    
        balance = address(this).balance;
    }

我们定义一个 external payableminusPayable() 函数,间接的调用 minus(),并且返回合约里的 ETH 余额(this 关键字可以让我们引用合约地址)。我们可以在调用 minusPayable() 时往合约里转入1个 ETH。

【从0学习Solidity】 3. 函数详解_Web3_06

我们可以在返回的信息中看到,合约的余额变为 1 ETH。

【从0学习Solidity】 3. 函数详解_Web3_07

【从0学习Solidity】 3. 函数详解_Web3_08

总结

在这一讲,我们介绍了 Solidity 中的函数。pureview 关键字比较难理解,在其他语言中没出现过:view 函数可以读取状态变量,但不能改写;pure 函数既不能读取也不能改写状态变量。

【从0学习Solidity】 3. 函数详解_可见性_09

如果这份博客对大家有帮助,希望各位给作者一个免费的点赞👍作为鼓励,并评论收藏一下⭐,谢谢大家!!!
制作不易,如果大家有什么疑问或给作者的意见,欢迎评论区留言。