【Solidity入门系列】函数的可见性与访问权限控制

2017/3/12 posted in  Solidity入门系列

在之前的文章中1我们介绍了Solidity语言函数的一些基本语法。下面来继续介绍作为一个分布式网络语言所特有的internalexternal这两种不同的函数调用方式,以及Solidity提供的对函数调用时的可见性控制语法。

一、 调用方式

Solidity封装了两种函数的调用方式internalexternal

internal

internal调用,实现时转为简单的EVM跳转,所以它能直接使用上下文环境中的数据,对于引用传递时将会变得非常高效(不用拷贝数据)。

在当前的代码单元内,如对合约内函数,引入的库函数,以及父类合约中的函数直接使用即是以internal方式的调用。我们来看个简单的例子:

pragma solidity ^0.4.0;

contract Test {
    function f(){}
    
    //以`internal`的方式调用
    function callInternally(){
        f();
    }
}

在上述代码中,callInternally()internal的方式对f()函数进行了调用。

external

external调用,实现为合约的外部消息调用。所以在合约初始化时不能external的方式调用自身函数,因为合约还未初始化完成。下面来看一个以external方式调用的例子:

pragma solidity ^0.4.0;

contract A{
    function f(){}
}

contract B{
    //以`external`的方式调用另一合约中的函数
    function callExternal(A a){
        a.f();
    }
}

虽然当前合约AB的代码放在一起,但部署到网络上后,它们是两个完全独立的合约,它们之间的方法调用是通过消息调用。上述代码中,在合约B中的callExternal()external的方式调用了合约Af()

external调用时,实际是向目标合约发送一个消息调用。消息中的函数定义部分是一个24字节大小的消息体,20字节为地址,4字节为函数签名2

this

我们可以在合约的调用函数前加this.来强制以external方式的调用。需要注意的是这里的this的用法与大多数语言的都不一致。

pragma solidity ^0.4.0;

contract A{
    function f() internal{}
    
    function callInternally(){
        f();
    }
    
    //以`external`的方式调用
    //f()只能以`internal`的方式调用
    //Untitled3:7:9: Error: Member "f" not found or not visible after argument-dependent lookup in contract A
    function callExternally(){
        //this.f();
    }
}

调用方式说明

上面所提到的internalexternal指的函数调用方式,请不要与后面的函数可见性声明的externalpublicinternalprivate弄混。声明只是意味着这个函数需要使用相对应的调用方式去调用。后续说明中会用以某某方式调用,来强调是对调用方式的阐述以加以区分。

二、函数的可见性

Solidity为函数提供了四种可见性,externalpublicinternalprivate

external

  • 声明为external的可以从其它合约或通过Transaction进行调用,所以声明为external的函数是合约对外接口的一部分。
  • 不能以internal的方式进行调用。
  • 有时在接收大的数据数组时性能更好。
pragma solidity ^0.4.5;

contract FuntionTest{
    function externalFunc() external{}

    function callFunc(){
        //以`internal`的方式调用函数报错
        //Error: Undeclared identifier.
        //externalFunc();
        
        //以`external`的方式调用函数
        this.externalFunc();
    }
}

声明为externalexternalFunc()只能以external的方式进行调用,以internal的方式调用会报Error: Undeclared identifier.

public

  • 函数默认声明为public
  • public的函数既允许以internal的方式调用,也允许以external的方式调用。
  • public的函数由于被外部合约访问,是合约对外接口的一部分。
pragma solidity ^0.4.5;

contract FuntionTest{
    //默认是public函数
    function publicFunc(){}

    function callFunc(){
        //以`internal`的方式调用函数
        publicFunc();
        
        //以`external`的方式调用函数
        this.publicFunc();
    }
}

我们可以看到声明为publicpublicFunc()允许两种调用方式。

internal

  • 在当前的合约或继承的合约中,只允许以internal的方式调用。
pragma solidity ^0.4.5;

contract A{
    //默认是public函数
    function internalFunc() internal{}

    function callFunc(){
        //以`internal`的方式调用函数
        internalFunc();
    }
}
contract B is A{
    //子合约中调用
    function callFunc(){
        internalFunc();
    }
}

上述例子中声明为internalinternalFunc()在定义合约,和子合约中均只能以internal的方式可以进行调用。

private

  • 只能在当前合约中被访问(不可在被继承的合约中访问)。
  • 即使声明为private,仍能被所有人查看到里面的数据。访问权限只是阻止了其它合约访问函数或修改数据。
pragma solidity ^0.4.5;

contract A{
    //默认是public函数
    function privateFunc() private{}

    function callFunc(){
        //以`internal`的方式调用函数
        privateFunc();
    }
}
contract B is A{
    //不可调用`private`
    function callFunc(){
        //privateFunc();
    }
}

上述例子中,声明为privateprivateFunc()只能在定义的合约中以internal的方式进行调用。

关于作者

专注基于以太坊(Ethereum)的相关区块链(Blockchain)技术,了解以太坊,Solidity,Truffle,web3.js。

个人博客: http://me.tryblockchain.org
Solidity中文翻译:http://solidity.tryblockchain.org

感谢您的支持

zan-code

处于某些特定的环境下,可以看到评论框,欢迎留言交流^_^。

友情链接: 区块链技术中文社区