二solidity 基础进阶（2.1）—— library 库合约《实战NFT web3 solidity(新版本0.8.+)》

Posted 2022-11-24 1_bit

《web3 solidity0.8.+版本（持续更新新版本内容） 基础到实战NFT开发》会及时更新新版本 solidity 内容，以及完成最终的 NFT 实战商业项目部分。

注：由于是付费专栏内容，若有错误请及时联系@1_bit，博客链接：https://blog.csdn.net/A757291228 ，或在文章下留言，收到后将会对错误进行改正，若是版本更新导致的问题也希望大家对错误进行提交，尽力去保证付费用户该得到的权益。

文章目录可查看：目录（文章更新中…）
更新内容将会在目录中更新…

友情提示：本系列文章读者最好学过一门编程语言，面向对象语言更佳，文章所有代码将会完整贴出。

一、库 library

solidity 中的 library 库合约跟合约编写方式类似，在 solidity 中的作用是减少代码冗余，减少重复代码；在 library 合约中，不能创建状态遍历，你可以理解为库合约 library 就是一个“流水线”，不提供“原料”只做流程处理。

一个 library 不能够被继承，也不能够接受以太，我们只编写流程代码，并且使用 library 还可以节省 gas，毕竟代码减少了对吧？

二、库 library 合约示例

首先我们在 remix 上创建一个合约，名为 LibraryDemo：

在这个合约中新建一个合约：

// SPDX-License-Identifier:MIT

pragma solidity ^0.8.7;

library LibraryDemo

从以上代码中可以看出，创建一个 库合约 非常简单，只需要把以前所使用的合约关键字 contract 换成 library 即可。

接着在这个结构体中创建一个 struct 结构体，并且给与一个成员变量 map，是一个 mapping 映射：

struct structData
   mapping(string=>uint32) map;

在这个时候就有同学疑问了，不是说不能创建状态变量吗？为什么这里创建了一个结构体？

如果没有这个疑问的同学，很好，你这点是理解的，其实在这里创建的是一个结构体，表示一种数据“结构”，从本质上来说这个结构体就是一个“数据结构”，此处我们并没有把这个结构体进行“实例化”之类的操作，所以它只是一种抽象的数据结构，即使我在内部创建了一个 map 映射，那也只是表示一种数据结构，就像你在一个 function 中创建一个 uint 类型的变量，那么这个变量也是属于 memory 对吧？

既然已经说清楚以上的结构体了，那么接下来我们在这个 library 中创建个方法：

function insertData(structData storage self,string memory _name,uint32 _age)public 
    self.map[_name]=_age;

以上这个方法叫做 insertData，顾名思义就是往里面插值，那往哪里插值呢？咱们可以看参数 structData storage self，这个参数是用 storage 进行修饰的，表示的是传入地址，那么传入地址过来的数据修改了，那么就表示本身进行了修改，所以此时所需要把值插入到的变量那应该就是 self，这个 self 是这个 structData 结构体类型的变量；接着还有两个参数，分别是 _name 和 _age，由于 string 是一个可变长的参，在这里使用了 memory 对其进行修饰。

这个函数的函数体中，solidity 代码 self.map[_name]=_age; 表示给结构体中的 map 赋值，这里使用 点运算符进行操作。

那么接下来就创建一个取值的方法：

function get(structData storage self,string memory _name)view public returns(uint32)
    return self.map[_name];

这个代码应该没啥好解释的吧？跟之前的类似，多了一个 view 对其进行修饰，毕竟是读数据，返回一个 uint32 的数据。

以上完整的 library 合约代码如下：

// SPDX-License-Identifier:MIT

pragma solidity ^0.8.7;

library LibraryDemo
    struct structData
        mapping(string=>uint32) map;
    

    function insertData(structData storage self,string memory _name,uint32 _age)public 
        self.map[_name]=_age;
    

    function get(structData storage self,string memory _name)view public returns(uint32)
        return self.map[_name];
    

三、调用 library 示例

接着开始 调用 library的示例，在同 sol 文件下编写一个合约名叫 CallLib：

contract CallLib

在合约中创建一个变量为 library 合约中 结构体 structData 的类似变量：

LibraryDemo.structData private libObj;

在这里直接使用合约名用点运算符可获取到合约内的内容，在这里 LibraryDemo.structData 就表示这个库合约中的 structData 结构体类型，并且修饰为这个名为 libObj 的结构体变量为 私有 private 。（注意不能设置为 public，规定为 private ）

若设置这个库合约的变量 libObj 为 public 即可得到一个报错：

接着就是创建两个方法了（上图已经暴露），一个叫做 insertName 另一个叫做 get。insertName 传入两个参数，一个是名另一个是年龄，在这里_name 参数是 string 变长类型所以使用了 memory，接着直接使用 library 合约 LibraryDemo 调用 insertData 方法，传入参数即可：

LibraryDemo.insertData(libObj,_name,_age);

在这里 libObj 为创建的合约结构体类型变量，在库合约中是 storage 修饰的，所以是传址，即在库合约中修改了值在 CallLib 合约中也会发生改变。

随后就是 get 方法：

function get(string memory _name)view public returns(uint32)
    return LibraryDemo.get(libObj,_name);

get 方法接收一个字符串类型的 _name 变量，之后返回年龄，所以 returns 所指定的返回类型为 uint32，接下来直接使用 库合约调用 get 方法传入名称即可。

最后部署合约，调用方法传入值即可：

多个值之间使用逗号隔开。

这第三点的完整代码如下：

// SPDX-License-Identifier:MIT

pragma solidity ^0.8.7;

library LibraryDemo
    struct structData
        mapping(string=>uint32) map;
    

    function insertData(structData storage self,string memory _name,uint32 _age)public 
        self.map[_name]=_age;
    

    function get(structData storage self,string memory _name)view public returns(uint32)
        return self.map[_name];
    


contract CallLib
    LibraryDemo.structData private libObj;

    function insertName(string memory _name,uint32 _age)public
        LibraryDemo.insertData(libObj,_name,_age);
    

    function get(string memory _name)view public returns(uint32)
        return LibraryDemo.get(libObj,_name);
    

四、调用 library sol

除了在一个sol文件中直接调用库合约，还可以直接调用合约文件，而在现实中往往也是这样做的，毕竟所有东西写在一个文件内看着还是非常头疼的。

接着我们创建一个sol 文件叫做CallLib.sol：

随后使用 import 关键字对文件进行引用：

import "./LibraryDemo.sol";

其中路径 "./" 表示当前路径下，若你直接使用 "/" 则表示根目录下。使用 import 在其后面写上所需要引入的文件路径即可。

接着代码编写与原来一致，完整的 CallLib.sol 代码如下：

// SPDX-License-Identifier:MIT

pragma solidity ^0.8.7;

import "./LibraryDemo.sol";

contract CallLib
    LibraryDemo.structData private libObj;

    function insertName(string memory _name,uint32 _age)public
        LibraryDemo.insertData(libObj,_name,_age);
    

    function get(string memory _name)view public returns(uint32)
        return LibraryDemo.get(libObj,_name);
    

编译没问题后部署后调用：