085-包的匿名导入(Blank Import)

Posted 2022-12-15 --Allen--

转眼间，Golang 的博客从春天写到了冬天，现在我们又回到了原点，不忘初心。那时候我们为了匆匆进入 Golang 的世界，几笔掠过了 Golang 项目结构的相关知识，也粗略的介绍了 Golang 的包相关的概念——《go 项目结构》。我们依靠这点知识，撑到了现在。如今，是时候再为你扩展一些关于 Golang 包以及相关的工具了。

1. 介绍

一路走来，你一定遇到过这样的情况：如果 import 的包没有使用，编译器就会报错。

// main.go
package main
import (
	"fmt"
)

func main() 
	a := 1
	b := 2
	x := a + b
	_ = x

如果你直接编译上面的代码，会报错:

# command-line-arguments
./main.go:4:2: imported and not used: "fmt"

解决的方法有两种：

• 注释或删除掉 import 语句
• 使用匿名导入（Blank Import）

第一种我就不说了，第二种非常简单，只需要改一句：

import (
	_ "fmt" // 在 "fmt" 前加一个 _
)

这样就可以绕过编译器的检查了。

2. 匿名导入（Blank Import）

当然了，上述两种方式是存在在本质区别的。我们知道，当程序启动后，一定会为先经过包初始化这一步，参考《包初始化》。所有被导入的包都会先经过初始化：

• 解决包的依赖顺序
• 初始化包级声明的变量
• 按顺序初始化包中每个文件里的 init 函数
• 每个文件中可以包含多个 init 函数，按顺序执行

你看，只要你写了 import 语句，那和不写完全是两码事。那在什么情况下使用匿名导入呢？

举个例子，在 golang 中有 image 这个包，它可以用于解码和编码不同格式的图片，如果你仔细学习过第一章的内容，那么一定不会陌生。下面是一个具体的示例，它用于将某种格式的图片转换为 jpeg 类型的图片。比如可以将 png 图片转成 jpeg 图片，使用方法也很简单：

> cat mandelbrot.png | go run convert.go > mandelbrot.jpeg

注：mandelbrot 图像在 《使用 go 绘制 Mandelbrot 分形图》 有过介绍。当然你可以为了避重就轻，自己找一张 png 格式的图片也是没问题的。

不过很遗憾，运行会报错：

err: image: unknown format

代码：

// convert.go
package main

import (
	"fmt"
	"image"
	"image/jpeg"
	"os"
)

func main() 
	img, kind, err := image.Decode(os.Stdin)
	if err != nil 
		fmt.Fprintf(os.Stderr, "err: %v\\n", err)
		return
	
	fmt.Fprintf(os.Stderr, "input format: %v\\n", kind)
	jpeg.Encode(os.Stdout, img, &jpeg.OptionsQuality: 95)

这是因为 image 包为了保持程序编译后体积较小，并不会自动加载所有的图片解码器。而加载解码器的方式需要用户手动 import 这个包。 这种使用 import 来动态加载插件（在这里是解码器) 的手法，也是编程中常用的技术，说不定以后你在工作环境中就可以用上。

在上面的例子中，我们并未 import "image/png" 包，因此也就未加载过 png 格式的解码器，所以运行失败了。

但是，如果你直接在上面的代码中加入 import "image/png" 这一行，程序编译又无法通过（因为并不会使用此包的任何方法），这还真是尴尬。

解决的方法就是使用匿名导入，这既解决了 png 解码器初始化的问题，又避免了 "imported and not used" 的报错。

添加一行 import _ "image/png" 即万事大吉，最后输出结果：

input format: png

同时也会生成一张 jpeg 格式的图片。

3. 总结

• 理解包初始化
• 掌握包匿名导入和应用场景