VSCode中使用Docker及Golang1.16的静态文件嵌入

编写一个简单的Go语言程序并放入容器运行起来

1、win10下安装docker桌面版，本文默认已经安装好，不再写安装细节。镜像仓库使用了golang:1.16.2-alpine和apline:latest，打包完镜像为13M左右，但不带Cgo。
2、创建website目录，并在该目录下创建server.go文件，内容如下：

package main

import (
    "fmt"
    "net/http"
)

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "hello world!")
}

func main() {
    http.HandleFunc("/", handler)
    fmt.Println("服务端口: 8080")
    http.ListenAndServe(":8080", nil)
}

同目录下创建Dockerfile文件，内容如下：

FROM golang:1.16.2-alpine AS builder
# 编译工作目录
WORKDIR /app
# 拷贝本地所有文件到编译工作目录
COPY . .
# 编译go文件,设置不调用Cgo
RUN CGO_ENABLED=0 GOOS=linux go build -o server

FROM alpine:latest
# 二进制文件存放目录
WORKDIR /app
# builder别称镜像目录生成文件放入工作目录
COPY --from=builder /app/server /app
# 打开8080端口
EXPOSE 8080
# 从工作目录运行server二进制可执行文件
ENTRYPOINT [ "/app/server" ]

3、在VSCode中安装Docker插件，安装完成后显示如下：

image.png

4、如上图所示，对Dockerfile文件内容单击右键，创建镜像(Build Image...)，创建完成后对镜像版本单击右键，执行“Run”命令：

image.png

5、执行完毕后Docker容器启动程序，如下图：

image.png

6、右击容器选择“Open in Browser”在浏览器中打开8080地址，结果如下：

image.png

对Go语言增加静态模板文件

1、创建一个templates文件夹，在文件夹下创建命名为index.html，文件中填写如下代码：

<h1>欢迎使用docker</h1>

<p>这个一个go web docker程序</p>

2、替换server.go程序，内容如下：

package main

import (
    "fmt"
    "html/template"
    "log"
    "net/http"
)

func IndexHandler(w http.ResponseWriter, r *http.Request) {
    t, err := template.ParseFiles("templates/index.html")
    if err != nil {
        log.Println(err)
    }
    err = t.Execute(w,nil)
    if err != nil {
        log.Println(err)
    }
}

func main() {
    http.HandleFunc("/",IndexHandler)
    fmt.Println("服务端口:8080")                 //控制台输出信息
    err := http.ListenAndServe(":8080", nil) //设置监听的端口
    if err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

4、Dockerfile用以下内容进行替换：

FROM golang:1.16.2-alpine AS builder
# 编译工作目录
WORKDIR /app
# 拷贝本地所有文件到编译工作目录
COPY . .
# 编译go文件,设置不调用Cgo
RUN CGO_ENABLED=0 GOOS=linux go build -o server

FROM alpine:latest
# 二进制文件存放目录
WORKDIR /app
# builder别称镜像目录生成文件放入工作目录
COPY --from=builder /app/server /app
# 拷贝本地template目录下的所有html文件到境像/app/templates目录下
COPY ./templates/*.html /app/templates/
# 打开8080端口
EXPOSE 8080
# 从工作目录运行server二进制可执行文件
ENTRYPOINT [ "/app/server" ]

3、VSCode的Docker中右击删除运行容器和镜像，然后重新执行第1节中的4到6内容，结果如下：

image.png

使用go1.16版本以后的embed包把静态文件嵌入二进文件

1、server.go内容用以下代码替换：

package main

import (
    "embed"
    "fmt"
    "html/template"
    "log"
    "net/http"
)

//go:embed templates/*.html
var templateFiles embed.FS

func IndexHandler(w http.ResponseWriter, r *http.Request) {
    t, err := template.ParseFS(templateFiles, "templates/index.html")
    if err != nil {
        panic(err)
    }
    if err = t.Execute(w, nil); err != nil {
        panic(err)
    }
}

func main() {
    http.HandleFunc("/", IndexHandler)
    fmt.Println("服务端口:8080")                 //控制台输出信息
    err := http.ListenAndServe(":8080", nil) //设置监听的端口
    if err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

2、当templates文件嵌入go语言的二进制编译文件后，删除Dockerfile里的templates拷贝，Dockerfile文件内容如下：

FROM golang:1.16.2-alpine AS builder
# 编译工作目录
WORKDIR /app
# 拷贝本地所有文件到编译工作目录
COPY . .
# 编译go文件,设置不调用Cgo
RUN CGO_ENABLED=0 GOOS=linux go build -o server

FROM alpine:latest
# 二进制文件存放目录
WORKDIR /app
# builder别称镜像目录生成文件放入工作目录
COPY --from=builder /app/server /app
# 打开8080端口
EXPOSE 8080
# 从工作目录运行server二进制可执行文件
ENTRYPOINT [ "/app/server" ]

3、VSCode的Docker中右击删除运行容器和镜像，然后重新执行第1节中的4到6内容，结果如下：

image.png

4、加入CSS样式等静态文件(JS同理)
新增scripts目录，并在目录下加入两个css文件分别为：styles.css和body.css
templates/index.html内容用以下代码替换：

<head>
<link rel="stylesheet" href="/scripts/styles.css">
</head>
<h1>欢迎使用docker</h1>

<p>这个一个go web docker程序</p>

scripts/styles.css内容如下：

p{
    background-color: red;
}

server.go代码如下：

package main

import (
    "embed"
    "fmt"
    "html/template"
    "log"
    "net/http"

    "github.com/gorilla/mux"
)

//go:embed templates/*.html
var templateFiles embed.FS

//go:embed scripts/*
var scriptFiles embed.FS

func IndexHandler(w http.ResponseWriter, r *http.Request) {
    t, err := template.ParseFS(templateFiles, "templates/index.html")
    if err != nil {
        panic(err)
    }
    if err = t.Execute(w, nil); err != nil {
        panic(err)
    }
}

func main() {
    router := mux.NewRouter()
    router.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("访问页面不存在"))
    })
    router.HandleFunc("/", IndexHandler)
    var scriptsServer = http.FileServer(http.FS(scriptFiles))
    router.PathPrefix("/scripts").Handler(http.StripPrefix("/", scriptsServer))

    server := &http.Server{Addr: ":8080", Handler: router}
    fmt.Println("服务端口:8080") //控制台输出信息
    if err := server.ListenAndServe(); err != nil {
        log.Printf("listen: %s\n", err)
    }
}

Docker重新生成镜像运行容器后结果如下：

image.png

上图显示结果为模板和静态样式都打包进入二进制文件中。

Go语言静态服务的漏洞

运行上面样例后，浏览器直接访问scripts路径会出现以下结果：

image.png

地址直接暴露了所有scripts目录下的文件，所以要对访问路径进行验证，验证代码如下：

// FileSystem custom file system handler
type FileSystem struct {
    fs http.FileSystem
}

// Open opens file
func (fs FileSystem) Open(path string) (http.File, error) {
    f, err := fs.fs.Open(path)
    if err != nil {
        return nil, err
    }
    s, _ := f.Stat()
    if s.IsDir() {
        index := strings.TrimSuffix(path, "/") + "/index.html"
        if _, err := fs.fs.Open(index); err != nil {
            return nil, err
        }
    }
    return f, nil
}

server.go内容替换为以下代码：

package main

import (
    "embed"
    "fmt"
    "html/template"
    "log"
    "net/http"
    "strings"

    "github.com/gorilla/mux"
)

//go:embed templates/*.html
var templateFiles embed.FS

//go:embed scripts/*
var scriptFiles embed.FS

func IndexHandler(w http.ResponseWriter, r *http.Request) {
    t, err := template.ParseFS(templateFiles, "templates/index.html")
    if err != nil {
        panic(err)
    }
    if err = t.Execute(w, nil); err != nil {
        panic(err)
    }
}

// FileSystem custom file system handler
type FileSystem struct {
    fs http.FileSystem
}

// Open opens file
func (fs FileSystem) Open(path string) (http.File, error) {
    f, err := fs.fs.Open(path)
    if err != nil {
        return nil, err
    }
    s, _ := f.Stat()
    if s.IsDir() {
        index := strings.TrimSuffix(path, "/") + "/index.html"
        if _, err := fs.fs.Open(index); err != nil {
            return nil, err
        }
    }
    return f, nil
}

func main() {
    router := mux.NewRouter()
    router.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("访问页面不存在"))
    })
    router.HandleFunc("/", IndexHandler)
    var scriptsServer = http.FileServer(FileSystem{http.FS(scriptFiles)})
    router.PathPrefix("/scripts").Handler(http.StripPrefix("/", scriptsServer))

    server := &http.Server{Addr: ":8080", Handler: router}
    fmt.Println("服务端口:8080") //控制台输出信息
    if err := server.ListenAndServe(); err != nil {
        log.Printf("listen: %s\n", err)
    }
}

运行后，scripts路由访问如下：

image.png

这样就不会暴露所有静态文件了