golang包

一、简介

1、到目前为止，演示的golang程序都只有一个文件，文件里包含一个main函数和几个其他的函数，在实际中，这种把所有源代码编写在一个文件的方法并不好用，以这种方式编写，代码的重用和维护都会很困难，而包(Package)解决了这样的问题

2、包用于组织golang源代码，提供了更好的可重用性与可读性，由于包提供了代码的封装，因此使得golang应用程序易于维护

3、例如，正在开发一个golang图像处理程序，它提供了图像的裁剪、锐化、模糊和彩色增强等功能，一种组织程序的方式就是根据不同的特性，把代码放到不同的包中，比如裁剪可以是一个单独的包，而锐化是另一个包，这种方式的优点是，由于彩色增强可能需要一些锐化的功能，因此彩色增强的代码只需要简单地导入锐化功能的包，就可以使用锐化的功能了，这样的方式使得代码易于重用

二、main函数和main包

1、所有可执行的golang程序都必须包含一个main函数，这个函数是程序运行的入口，main函数应该放置于main包中

2、package packagename这行代码指定了某一源文件属于一个包，它应该放在每一个源文件的第一行

3、在golang工作区的src文件夹中创建一个geometry文件夹 => 在geometry文件夹中创建一个geometry.go文件 => 在golang程序中创建一个main函数和main包

// geometry.go

package main 

import "fmt"

func main() {  
    fmt.Println("Geometrical shape properties")
}

/*
package main这一行指定该文件属于main包
import "packagename"语句用于导入一个已存在的包，这里导入了fmt包，包内含有Println方法
接下来是main函数，它会打印Geometrical shape properties
*/

4、执行go install geometry，编译上述程序，该命令会在geometry文件夹内搜索拥有main函数的文件，在这里，它找到了geometry.go，接下来，它编译并产生一个名为geometry(在 windows 下是 geometry.exe)的二进制文件，该二进制文件放置于工作区的bin文件夹

5、工作区的目录结构

-src
    -geometry
        gemometry.go
-bin
    geometry.exe

6、执行workspacepath/bin/geometry运行该程序(workspacepath是工作区路径)，这个命令会执行bin文件夹里的geometry二进制文件，结果就是输出Geometrical shape properties

三、自定义包

1、创建自定义的包

①属于某一个包的源文件都应该放置于一个单独命名的文件夹里，按照golang的惯例，应该用包名命名该文件夹

②组织代码，使得所有与矩形有关的功能都放入rectangle包中

③创建一个自定义包rectangle，它有一个计算矩形的面积和对角线的函数

③在geometry文件夹中，创建一个命名为rectangle的文件夹。在rectangle文件夹中，所有文件都会以package rectangle作为开头，因为它们都属于rectangle包

④在rectangle文件夹中，再创建一个名为rectprops.go的文件

// rectprops.go

package rectangle

import "math"

func Area(len, wid float64) float64 {  
    area := len * wid
    return area
}

func Diagonal(len, wid float64) float64 {  
    diagonal := math.Sqrt((len * len) + (wid * wid))
    return diagonal
}

/*
创建了两个函数用于计算Area和Diagonal，矩形的面积是长和宽的乘积，矩形的对角线是长与宽平方和的平方根，math包下面的Sqrt函数用于计算平方根
*/

2、导入自定义包

①为了使用自定义包，必须要先导入它，导入自定义包的语法为import path，必须指定自定义包相对于工作区内src文件夹的相对路径

-src
    -geometry
        geometry.go
        -rectangle
            rectprops.go

②代码

// geometry.go

package main 

import (  
    "fmt"
    "geometry/rectangle"  // 导入自定义包
)

func main() {  
    var rectLen, rectWidth float64 = 6, 7
    fmt.Println("Geometrical shape properties")  // 输出：Geometrical shape properties  
    fmt.Printf("area of rectangle %.2f\n", rectangle.Area(rectLen, rectWidth))  // 输出：area of rectangle 42.00  
    fmt.Printf("diagonal of the rectangle %.2f ", rectangle.Diagonal(rectLen, rectWidth))  // 输出：diagonal of the rectangle 9.22
}

/*
导入了rectangle包，并调用了里面的Area和Diagonal函数，得到矩形的面积和对角线，Printf内的格式说明符%.2f会将浮点数截断到小数点两位
*/

3、导出名字(Exported Names)：将rectangle包中的函数Area和Diagonal首字母大写，在golang中具有特殊意义，任何以大写字母开头的变量或者函数都是被导出的名字，其它包只能访问被导出的函数和变量，需要在main包中访问Area和Diagonal函数，因此将它们的首字母大写

四、init函数

1、所有包都可以包含一个init函数，init函数不应该有任何返回值类型和参数，在代码中也不能显式地调用它

func init() {  
}

2、init函数可用于执行初始化任务，也可用于在开始执行之前验证程序的正确性

3、包的初始化顺序：首先初始化包级别(Package Level)变量 => 紧接着调用init函数，包可以有多个init函数(在一个文件或分布于多个文件中)，它们按照编译器解析它们的顺序进行调用

4、如果一个包导入了另一个包，会先初始化被导入的包

5、尽管一个包可能会被导入多次，但是它只会被初始化一次

6、在rectprops.go文件中添加了一个init函数

// rectprops.go

package rectangle

import "math"  
import "fmt"

func init() {  
    fmt.Println("rectangle package initialized")
}
func Area(len, wid float64) float64 {  
    area := len * wid
    return area
}

func Diagonal(len, wid float64) float64 {  
    diagonal := math.Sqrt((len * len) + (wid * wid))
    return diagonal
}

/*
这是一个简单的init函数，它仅打印rectangle package initialized
*/

7、再来修改main包，矩形的长和宽都应该大于0，在geometry.go中使用init函数和包级别的变量来检查矩形的长和宽

// geometry.go

package main 

import (  
    "fmt"
    "geometry/rectangle" // 导入自定义包，输出：rectangle package initialized  
    "log"
)

// 包级别变量
var rectLen, rectWidth float64 = 6, 7 

// init函数会检查长和宽是否大于0
func init() {  
    println("main package initialized")  // 输出：main package initialized 
    if rectLen < 0 {
        log.Fatal("length is less than zero")
    }
    if rectWidth < 0 {
        log.Fatal("width is less than zero")
    }
}

func main() {  
    fmt.Println("Geometrical shape properties")  // 输出：Geometrical shape properties
    fmt.Printf("area of rectangle %.2f\n", rectangle.Area(rectLen, rectWidth))  // 输出：area of rectangle 42.00
    fmt.Printf("diagonal of the rectangle %.2f ",rectangle.Diagonal(rectLen, rectWidth))  // 输出：diagonal of the rectangle 9.22
}

/*
变量rectLen和rectWidth从main函数级别移到了包级别
添加了init函数，当rectLen或rectWidth小于0时，init函数使用log.Fatal函数打印一条日志，并终止了程序
main包的初始化顺序为：
1、首先初始化被导入的包，因此，首先初始化了rectangle包
2、接着初始化了包级别的变量rectLen和rectWidth
3、调用init函数
4、最后调用main函数
*/

8、总结

①程序会首先调用rectangle包的init函数，然后，会初始化包级别的变量rectLen和rectWidth

②接着调用main包里的init函数，该函数检查rectLen和rectWidth是否小于0，如果条件为真，则终止程序

③在这里两个条件都为假，因此程序继续执行，最后调用了 main 函数

9、如果将geometry.go中的var rectLen, rectWidth float64 = 6, 7改为var rectLen, rectWidth float64 = -6, 7，程序的结果

rectangle package initialized  
main package initialized  
2018/08/08 00:28:28 length is less than zero

<!--
像往常一样，会首先初始化rectangle包，然后是main包中的包级别的变量rectLen和rectWidth
rectLen为负数，因此当运行init函数时，程序在打印length is less than zero后终止
-->
//

五、空白标识符(Blank Identifier)

1、导入了包，却不在代码中使用它，这在golang中是非法的，当这么做时，编译器会报错，其原因是为了避免导入过多未使用的包，从而导致编译时间显著增加

2、然而，在程序开发的活跃阶段，又常常会先导入包，而暂不使用它，遇到这种情况就可以使用空白标识符_(下划线)

package main

import (  
    "geometry/rectangle" 
)

var _ = rectangle.Area  // 错误屏蔽器

func main() {
}

/*
var _ = rectangle.Area这一行屏蔽了错误
这些错误屏蔽器(Error Silencer)应该在程序开发结束时就移除它们，包括那些还没有使用过的包
由此建议在import语句下面的包级别范围中写上错误屏蔽器
*/

3、有时候导入一个包，只是为了确保它进行了初始化，而无需使用包中的任何函数或变量，例如，或许需要确保调用了rectangle包的init函数，而不需要在代码中使用它，这种情况也可以使用空白标识符

package main 

import (
    _ "geometry/rectangle"  // 输出：rectangle package initialized 
)
func main() {
}

/*
尽管在所有代码里，都没有使用这个包，但还是成功初始化了它
*/