# Note001 Solidity 笔记 基础（一）

By [Newman Li](https://paragraph.com/@newman-li) · 2022-05-04

---

### 合约基础

Solidity的代码都包裹在合约里面，每一份合约就是一台以太币应用的基本模块，

所有的变量和函数都属于一份合约，他是你所有应用的起点。

一份名为HelloSolidity 的空合约如下：

    contract HelloSolidity {
          ///内容
    }
    

### 版本指令

在每一份合约文件 的第一行都要写上"version prama" - 标明Solidity编译器的版本，以避免将来新的编译器可能破坏你的代码。

例如：pragma solidity ^0.4.19;(当前solidity的最新版版是0.4.19).

综上所述， 下面就是一个最基本的合约 - 每次建立一个新的项目时的第一段代码：

    pragma solidity ^0.4.19;
    
    contract HelloWorld {
          ///内容
    }
    

### 状态变量和整数

**状态变量** 是被永久地保存在合约中，也就是说他们被写入以太币区块链中，想象成一个数据库。

例如：

    contract Example {
      //这个无符号整数将会永久的被保存在区块链中
      uint myUnsignedInteger = 100;
    }
    

在上面例子中，定义myUnisignedInteger 为uint类型，并赋值100.

### 无符号整数：uint

uint 无符号整数类型，指其值不能是负数，对于有符号的整数存在名为int的数据类型。

> 注意：Solidity中，uint实际上是uint256的代名词，一个256位的无符号整数，你也可以定义位数少的uints — uint8，uint16，uint32，等…… 但一般来讲你愿意使用简单的uint，除非你在某些特殊情况下

### 数学运算

在 Solidity 中，数学运算很直观明了，与其它程序设计语言相同:

*   加法: `x + y`
    
*   减法: `x - y`,
    
*   乘法: `x * y`
    
*   除法: `x / y`
    
*   取模 / 求余: `x % y` _(例如,_ `13 % 5` 余 `3`, 因为13除以5，余3)
    

Solidity 还支持 **_乘方操作_** (如：x 的 y次方） // 例如： 5 \*\* 2 = 25

    uint x = 5 ** 2; // equal to 5^2 = 25
    

### 结构体

有时你需要更复杂的数据类型，Solidity 提供了 **结构体**:

    struct Person {
      uint age;
      string name;
    }
    

结构体允许你生成一个更复杂的数据类型，它有多个属性。

> 注：我们刚刚引进了一个新类型, `string`。 字符串用于保存任意长度的 UTF-8 编码数据。 如： `string greeting = "Hello world!"`。

### 数组

如果你想建立一个集合，可以用 **_数组_**\*\*这样的数据类型. Solidity 支持两种数组: \*\***_静态_** 数组和_动态_ 数组:

// 固定长度为2的静态数组:

uint\[2\] fixedArray;

// 固定长度为5的string类型的静态数组:

string\[5\] stringArray;

// 动态数组，长度不固定，可以动态添加元素:

uint\[\] dynamicArray;

你也可以建立一个 **_结构体_**类型的数组 例如，上一章提到的 `Person`:

Person\[\] people; // 这是动态数组，我们可以不断添加元素

记住：状态变量被永久保存在区块链中。所以在你的合约中创建动态数组来保存成结构的数据是非常有意义的。

公共数组
----

你可以定义 `public` 数组, Solidity 会自动创建 **_getter_** 方法. 语法如下:

Person\[\] public people;

其它的合约可以从这个数组读取数据（但不能写入数据），所以这在合约中是一个有用的保存公共数据的模式。

定义函数
====

在 Solidity 中函数定义的句法如下:

function eatHamburgers(string \_name, uint \_amount) {

}

这是一个名为 `eatHamburgers` 的函数，它接受两个参数：一个 `string`类型的 和 一个 `uint`类型的。现在函数内部还是空的。

> 注：: 习惯上函数里的变量都是以(`_`)开头 (但不是硬性规定) 以区别全局变量。我们整个教程都会沿用这个习惯。

我们的函数定义如下:

eatHamburgers("vitalik", 100);

使用结构体和数组
========

创建新的结构体
-------

还记得上个例子中的 `Person` 结构吗？

struct Person {

    uint age;
    
    string name;
    

}

Person\[\] public people;

现在我们学习创建新的 `Person` 结构，然后把它加入到名为 `people` 的数组中.

// 创建一个新的Person:

Person satoshi = Person(172, "Satoshi");

// 将新创建的satoshi添加进people数组:

people.push(satoshi);

你也可以两步并一步，用一行代码更简洁:

people.push(Person(16, "Vitalik"));

> 注：`array.push()` 在数组的 **尾部** 加入新元素 ，所以元素在数组中的顺序就是我们添加的顺序， 如:

uint\[\] numbers;

numbers.push(5);

numbers.push(10);

numbers.push(15);

// numbers is now equal to \[5, 10, 15\]

私有 / 公共函数
=========

Solidity 定义的函数的属性默认为`公共`。 这就意味着任何一方 (或其它合约) 都可以调用你合约里的函数。

显然，不是什么时候都需要这样，而且这样的合约易于受到攻击。 所以将自己的函数定义为`私有`是一个好的编程习惯，只有当你需要外部世界调用它时才将它设置为`公共`。

如何定义一个私有的函数呢？

uint\[\] numbers;

function \_addToArray(uint \_number) private {

    numbers.push(_number);
    

}

这意味着只有我们合约中的其它函数才能够调用这个函数，给 `numbers` 数组添加新成员。

可以看到，在函数名字后面使用关键字 `private` 即可。和函数的参数类似，私有函数的名字用(`_`)起始。

函数的更多属性
=======

本章中我们将学习函数的返回值和修饰符。

返回值
---

要想函数返回一个数值，按如下定义：

string greeting = "What's up dog";

function sayHello() public returns (string) {

    return greeting;
    

}

Solidity 里，函数的定义里可包含返回值的数据类型(如本例中 `string`)。

函数的修饰符
------

上面的函数实际上没有改变 Solidity 里的状态，即，它没有改变任何值或者写任何东西。

这种情况下我们可以把函数定义为 **_view_**, 意味着它只能读取数据不能更改数据:

function sayHello() public view returns (string) {

Solidity 还支持 **_pure_** 函数, 表明这个函数甚至都不访问应用里的数据，例如：

function \_multiply(uint a, uint b) private pure returns (uint) {

    return a * b;
    

}

这个函数甚至都不读取应用里的状态 — 它的返回值完全取决于它的输入参数，在这种情况下我们把函数定义为 **_pure_**.

> 注：可能很难记住何时把函数标记为 pure/view。 幸运的是， Solidity 编辑器会给出提示，提醒你使用这些修饰符。

Keccak256 和 类型转换
================

如何让 `_generateRandomDna` 函数返回一个全(半) 随机的 `uint`?

Ethereum 内部有一个散列函数`keccak256`，它用了SHA3版本。一个散列函数基本上就是把一个字符串转换为一个256位的16进制数字。字符串的一个微小变化会引起散列数据极大变化。

这在 Ethereum 中有很多应用，但是现在我们只是用它造一个伪随机数。

例子:

//6e91ec6b618bb462a4a6ee5aa2cb0e9cf30f7a052bb467b0ba58b8748c00d2e5

keccak256("aaaab");

//b1f078126895a1424524de5321b339ab00408010b7cf0e6ed451514981e58aa9

keccak256("aaaac");

显而易见，输入字符串只改变了一个字母，输出就已经天壤之别了。

> 注: 在区块链中**安全地**产生一个随机数是一个很难的问题， 本例的方法不安全，但是在我们的Zombie DNA算法里不是那么重要，已经很好地满足我们的需要了。

类型转换
----

有时你需要变换数据类型。例如:

uint8 a = 5;

uint b = 6;

// 将会抛出错误，因为 a \* b 返回 uint, 而不是 uint8:

uint8 c = a \* b;

// 我们需要将 b 转换为 uint8:

uint8 c = a \* uint8(b);

上面, `a * b` 返回类型是 `uint`, 但是当我们尝试用 `uint8` 类型接收时, 就会造成潜在的错误。如果把它的数据类型转换为 `uint8`, 就可以了，编译器也不会出错。

事件
==

我们的合约几乎就要完成了！让我们加上一个**事件**.

**事件** 是合约和区块链通讯的一种机制。你的前端应用“监听”某些事件，并做出反应。

例子:

// 这里建立事件

event IntegersAdded(uint x, uint y, uint result);

function add(uint \_x, uint \_y) public {

    uint result = _x + _y;
    
    //触发事件，通知app
    
    IntegersAdded(_x, _y, result);
    
    return result;
    

}

你的 app 前端可以监听这个事件。JavaScript 实现如下:

YourContract.IntegersAdded（函数（错误，结果）{

    // 干些事
    

})

---

*Originally published on [Newman Li](https://paragraph.com/@newman-li/note001-solidity)*