0x00 存在意義
權且當作Docker打包的練習。
顯然可以通過構造請求獲得每天的桌布，但是如果想要優雅地在其它地方使用這一網路資源，封裝一個RESTful API將會保證整潔美觀，在編寫CSS等場景中會非常方便。
0x01 程式碼實現
首先是專案的目錄結構：
│ bw.exe
│ Dockerfile
│ go.mod
│ go.sum
│ main.go
│ README.md
│
├─command
│ command.go
│
├─image
│ favicon.ico
│
├─roothandler
│ roothandler.go
│
└─xmlhandler
response.go
xmlhandler.go
介面邏輯
先向上游請求XML，通過處理獲得關鍵資訊，然後形成JSON作為介面返回格式（也包括直接重定向到圖片，但是沒有更多文字資訊，可用於CSS引入）。
介面引數
介面設定了幾個引數：
resolution: [1920,1366,3840]圖片的解析度，預設為
1920，遞增依次為HD、Full HD、UHD（4K）品質。在請求XML時未被使用，會在後續拼接到圖片的連結中。format: [json,image]返回形式，預設為
json。在請求XML時未被使用，介面根據這個引數決定返回型別。index: [0, +∞)圖片序號，從
0開始。在請求XML時需要使用。mkt: [zh-CN,en-US,ja-JP,en-AU,en-UK,de-DE,en-NZ,en-CA]地區，決定了使用語言，預設為
zh-CN。在請求XML時需要使用。
處理XML
先向介面上游請求資料，以XML形式返回。
xmlhandler/xmlhandler.go
package xmlhandler
import (
"fmt"
"io/ioutil"
"net/http"
"time"
"github.com/beevik/etree"
)
const (
BingURL = "https://cn.bing.com"
BingAPI = "https://cn.bing.com/HPImageArchive.aspx?format=xml&idx=%d&n=1&mkt=%s"
)
var Resolution map[string]string
var Markets map[string]bool
func init() {
Resolution = map[string]string{
"1366": "1366x768.jpg", // HD
"1920": "1920x1080.jpg", // Full HD
"3840": "UHD.jpg", // 3840×2160
}
Markets = map[string]bool{
"en-US": true,
"zh-CN": true,
"ja-JP": true,
"en-AU": true,
"en-UK": true,
"de-DE": true,
"en-NZ": true,
"en-CA": true,
}
}
// Get: parse .XML from Bing API
func Get(index uint, market string, resolution string) (*Response, error) {
if _, ok := Resolution[resolution]; !ok {
return nil, fmt.Errorf("resolution %s not supported", resolution)
}
if _, ok := Markets[market]; !ok {
return nil, fmt.Errorf("market %s not supported", market)
}
// new http.Client
var client = &http.Client{
Timeout: 5 * time.Second,
}
// new http.Request
var request, err1 = http.NewRequest(http.MethodGet, fmt.Sprintf(BingAPI, index, market), nil)
if err1 != nil {
return nil, fmt.Errorf("http.NewRequest error: %s", err1)
}
request.Header.Add("Referer", "https://cn.bing.com")
request.Header.Add(
"User-Agent",
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36 Edg/92.0.902.84",
)
// request
var resp, err2 = client.Do(request)
if err2 != nil {
return nil, fmt.Errorf("client.Do error: %s", err2)
}
defer resp.Body.Close()
// parse body
// nice etree!!! (github.com/beevik/etree)
var body, err3 = ioutil.ReadAll(resp.Body)
if err3 != nil {
return nil, fmt.Errorf("ioutil.ReadAll error: %s", err3)
}
var doc = etree.NewDocument()
if err4 := doc.ReadFromBytes(body); err4 != nil {
return nil, fmt.Errorf("ReadFromBytes error: %s", err4)
}
// return Response
img := doc.SelectElement("images").SelectElement("image")
return &Response{
SDate: img.SelectElement("startdate").Text(),
EDate: img.SelectElement("enddate").Text(),
URL: fmt.Sprintf("%s%s_%s", BingURL, img.SelectElement("urlBase").Text(), Resolution[resolution]),
Copyright: img.SelectElement("copyright").Text(),
CopyrightLink: img.SelectElement("copyrightlink").Text(),
}, nil
}
xmlhandler/response.go
定義了Response結構體，作為程式內部首次請求的返回格式。
package xmlhandler
// definition of struct Response
type Response struct {
SDate string `json:"sdate"`
EDate string `json:"edate"`
URL string `json:"url"`
Copyright string `json:"copyright"`
CopyrightLink string `json:"copyright_link"`
}
形成JSON
roothandler/roothandler.go
package roothandler
import (
"Bing-Wallpaper-RESTful/xmlhandler"
"net/http"
"strconv"
"github.com/gin-gonic/gin"
)
// RootHandler: serve as default API using gin
func RootHandler(c *gin.Context) {
// set default query params
resolution := c.DefaultQuery("resolution", "1920")
format := c.DefaultQuery("format", "json")
index := c.DefaultQuery("index", "0")
market := c.DefaultQuery("mkt", "zh-CN")
// check index
uIndex, err := strconv.ParseUint(index, 10, 64)
if err != nil {
// index invalid
c.String(http.StatusInternalServerError, "image index invalid")
return
}
// check format
if format != "json" && format != "image" {
c.String(http.StatusInternalServerError, "format invalid, only `json` or `image` available")
return
}
// fetch info from Bing using xmlhandler
response, err := xmlhandler.Get(uint(uIndex), market, resolution)
if err != nil {
c.String(http.StatusInternalServerError, err.Error())
return
}
// redirect to image URL directly
if format == "image" && response.URL != "" {
c.Redirect(http.StatusTemporaryRedirect, response.URL)
return
}
// render response as JSON
c.JSON(http.StatusOK, response)
}
命令列設計
command/command.go
規定命令列引數並定義具體執行函式。
package command
import (
"Bing-Wallpaper-RESTful/roothandler"
"fmt"
"github.com/gin-gonic/gin"
"github.com/spf13/cobra"
"github.com/thinkerou/favicon"
)
// command-line
var Cmd = &cobra.Command{
Use: "run",
Short: "Run this API service",
Long: `Run this API service`,
Run: run,
}
func run(cmd *cobra.Command, args []string) {
gin.SetMode(gin.ReleaseMode)
router := gin.Default()
router.Use(favicon.New("./image/favicon.ico"))
router.GET("/", roothandler.RootHandler)
router.Run(":9002") // default port: 9002
fmt.Println("API is running...")
}
主函式
main.go
package main
import (
"Bing-Wallpaper-RESTful/command"
"fmt"
"os"
"github.com/spf13/cobra"
)
var argVerbose bool
var rootCmd *cobra.Command
func init() {
rootCmd = &cobra.Command{
Use: "bw",
Short: "Bing wallpaper API",
Long: "Top level command for Bing wallpaper API service",
}
rootCmd.PersistentFlags().BoolVarP(&argVerbose, "verbose", "v", false, "verbose output")
rootCmd.AddCommand(
command.Cmd,
)
}
func main() {
if err1 := rootCmd.Execute(); err1 != nil {
fmt.Println(err1)
os.Exit(1)
}
}
0x02 程式試用
打包和幫助
command.go中的run函式對Web框架gin進行了設定，將作為發行版進行打包，僅對根路徑/進行服務，接受GET，佔用埠9002。
雖然Golang圖形庫比較欠缺發展，但是命令列的格式化庫確實很優雅。
go build -o bw.exe
執行
bw run
同時可以看到gin的日誌資訊。
CSS引入
測試CSS匯入，format要設定為image。執行Live Server。
0x03 Docker
FROM golang:alpine
ENV GO111MODULE=on \
CGO_ENABLED=0 \
GOOS=linux \
GOARCH=amd64 \
GOPROXY="https://goproxy.cn,direct"
RUN mkdir -p /home/www/bw
WORKDIR /home/www/bw
COPY . .
RUN go build -o bw .
WORKDIR /dist
RUN cp /home/www/bw/bw .
RUN mkdir image .
RUN cp /home/www/bw/image/favicon.ico ./image/favicon.ico
# server port
EXPOSE 9002
# run
CMD ["/dist/bw", "run"]
由於有favicon.ico這一靜態資源，所以需要注意複製。打包二進位制時預設不會嵌入靜態資源，需要使用第三方包（大量可選）或者1.16版本新增的embed功能進行嵌入，不然只能如上覆制一遍資源。
用官方映象打包使得體積過大了。