简介
在 Solidity 中，库（Library） 是一种特殊的智能合约，用于封装可复用的逻辑或功能。库与普通合约的区别在于，它不能保存状态变量，也不能接收 ETH。库可以被其他合约直接调用，从而减少代码冗余，提高开发效率。
特点
- 代码复用：封装通用逻辑，多个合约可以共享同一库
- 无状态：库不能定义或修改状态变量
- 直接调用：使用 delegatecall 将库的逻辑运行在调用合约的上下文中
- 不可部署独立逻辑：库的函数必须是内部函数或通过合约调用，不能独立执行
库的类型
1. 内部库
- 函数直接被编译器内联到调用合约中
- 没有单独的部署地址
- 调用成本低，无需 delegatecall
library Math {
function add(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
}
contract Example {
using Math for uint256;
function sum(uint256 a, uint256 b) public pure returns (uint256) {
return a.add(b); // 调用库的 add 函数
}
}
2. 外部库
- 需要单独部署，库有自己的地址
- 调用时通过 delegatecall 运行在调用合约的上下文中
- 优点：可共享逻辑，减少重复部署
// 库代码
library ExternalMath {
function multiply(uint256 a, uint256 b) public pure returns (uint256) {
return a * b;
}
}
调用代码
contract Example {
using ExternalMath for uint256;
function product(uint256 a, uint256 b) public pure returns (uint256) {
return a.multiply(b); // 调用库的 multiply 函数
}
}
库的声明与使用
1. 库的声明
- 使用 library 关键字定义
- 通常包含纯函数（pure）或只读函数（view）
library Math {
function add(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
function subtract(uint256 a, uint256 b) internal pure returns (uint256) {
require(a >= b, "Underflow");
return a - b;
}
}
2. 库的使用
- 直接调用：合约可以直接调用库中的函数。
- using for 语法糖：将库函数附加到基础类型，调用更简洁
contract Example {
using Math for uint256;
function compute(uint256 a, uint256 b) public pure returns (uint256) {
return a.add(b); // 等同于 Math.add(a, b)
}
}
作用域：
库的部署
内联库编译时直接将代码内联到合约中，不需要单独部署，因此这里只考虑外部库的部署。
async function deployLibrary() {
// 1. 部署库合约
const MathUtils = await hre.ethers.getContractFactory("MathUtils");
const mathUtils = await MathUtils.deploy();
await mathUtils.deployed();
console.log("MathUtils库部署地址:", mathUtils.address);
return mathUtils.address;
}
- 链接库地址: 在部署主合约时，将库地址与主合约链接
async function deployMainContract(libraryAddress) {
// 2. 部署主合约并链接库
const Calculator = await hre.ethers.getContractFactory("Calculator", {
libraries: {
MathUtils: libraryAddress // 指定库地址
}
});
const calculator = await Calculator.deploy();
await calculator.deployed();
console.log("Calculator主合约部署地址:", calculator.address);
return calculator.address;
}
// 执行部署
async function main() {
const libAddress = await deployLibrary();
await deployMainContract(libAddress);
}
main();
## 使用场景
* 工具函数集合（数学/数组/地址操作）
library SafeMath {
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
require(c >= a, "Overflow");
return c;
}
}
* 安全扩展（SafeERC20/SafeMath）
* 复杂逻辑封装
* 可升级合约的存储层
// 存储库（所有版本共享）
library StorageLib {
struct Layout {
uint256 value;
address owner;
}
bytes32 internal constant STORAGE_SLOT =
keccak256("upgradeable.contracts.storage");
function layout() internal pure returns (Layout storage l) {
bytes32 slot = STORAGE_SLOT;
assembly {
l.slot := slot
}
}
}
// 逻辑合约 V1
contract LogicV1 {
using StorageLib for StorageLib.Layout;
function setValue(uint256 v) public {
StorageLib.layout().value = v;
}
}
// 逻辑合约 V2（升级后）
contract LogicV2 {
using StorageLib for StorageLib.Layout;
function setValueWithOwner(uint256 v) public {
StorageLib.Layout storage l = StorageLib.layout();
l.value = v;
l.owner = msg.sender; // 新增功能
}
}
## 库的优缺点
- 优点
- 代码复用，减少合约冗余
- 提高代码可读性和模块化设计
- 减少逻辑错误，便于维护
- 缺点
- 外部库调用增加了 Gas 消耗
- 内联库可能导致主合约体积增大
- 如果库被错误使用，可能导致存储冲突问题
## 注意事项
- 权限管理：库函数不能直接访问状态变量，但通过 delegatecall 运行时，仍可以访问调用合约的上下文，需谨慎使用。
- Gas 成本
- 内联库的函数更节省 Gas，但会增加合约大小。
- 外部库调用会使用 delegatecall，增加调用成本。
- 存储冲突：库运行在调用合约的存储上下文中，确保存储布局一致。
- 不可变性： 库一旦部署，逻辑不可更改。对于可升级场景，需设计代理模式。
