msb-public
/
cloudreve
mirror of https://github.com/cloudreve/Cloudreve
1
0
Code Issues Projects Releases Wiki Activity

use go:embed for static resources (#1107)

Browse Source 
* feat: use go:embed to embed static files

* ci: fix broken test

* docs: update readme.md

* chore: remove statik

* feat: simplify code

Co-authored-by: AaronLiu <abslant@126.com>
pull/1198/head
Ink33 3 years ago committed by GitHub
parent ec776ac837
commit 84807be1ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 215 additions and 255 deletions
Show Stats Download Patch File Download Diff File

96
.github/workflows/build.yml vendored
Unescape View File

@ -9,53 +9,49 @@ jobs:
name: Build name: Build
runs-on: ubuntu-18.04 runs-on: ubuntu-18.04
steps: steps:
- name: Set up Go 1.17
- name: Set up Golang uses: actions/setup-go@v2
uses: actions/setup-go@v1 with:
with: go-version: "1.17"
go-version: 1.17 id: go
id: go
- name: Check out code into the Go module directory
- name: Check out code into the Go module directory uses: actions/checkout@v2
uses: actions/checkout@v2 with:
with: clean: false
clean: false submodules: "recursive"
submodules: 'recursive' - run: |
- run: | git fetch --prune --unshallow --tags
git fetch --prune --unshallow --tags
- name: Get dependencies and build
- name: Get dependencies and build run: |
run: | sudo apt-get update
go install github.com/rakyll/statik sudo apt-get -y install gcc-mingw-w64-x86-64
export PATH=$PATH:~/go/bin/ sudo apt-get -y install gcc-arm-linux-gnueabihf libc6-dev-armhf-cross
statik -src=models -f sudo apt-get -y install gcc-aarch64-linux-gnu libc6-dev-arm64-cross
sudo apt-get update chmod +x ./build.sh
sudo apt-get -y install gcc-mingw-w64-x86-64 ./build.sh -r b
sudo apt-get -y install gcc-arm-linux-gnueabihf libc6-dev-armhf-cross
sudo apt-get -y install gcc-aarch64-linux-gnu libc6-dev-arm64-cross - name: Upload binary files (windows_amd64)
chmod +x ./build.sh uses: actions/upload-artifact@v2
./build.sh -r b with:
name: cloudreve_windows_amd64
- name: Upload binary files (windows_amd64) path: release/cloudreve*windows_amd64.*
uses: actions/upload-artifact@v2
with: - name: Upload binary files (linux_amd64)
name: cloudreve_windows_amd64 uses: actions/upload-artifact@v2
path: release/cloudreve*windows_amd64.* with:
name: cloudreve_linux_amd64
- name: Upload binary files (linux_amd64) path: release/cloudreve*linux_amd64.*
uses: actions/upload-artifact@v2
with: - name: Upload binary files (linux_arm)
name: cloudreve_linux_amd64 uses: actions/upload-artifact@v2
path: release/cloudreve*linux_amd64.* with:
name: cloudreve_linux_arm
- name: Upload binary files (linux_arm) path: release/cloudreve*linux_arm.*
uses: actions/upload-artifact@v2
with: - name: Upload binary files (linux_arm64)
name: cloudreve_linux_arm uses: actions/upload-artifact@v2
path: release/cloudreve*linux_arm.* with:
name: cloudreve_linux_arm64
- name: Upload binary files (linux_arm64) path: release/cloudreve*linux_arm64.*
uses: actions/upload-artifact@v2
with:
name: cloudreve_linux_arm64
path: release/cloudreve*linux_arm64.*

67
.github/workflows/test.yml vendored
Unescape View File

@ -2,46 +2,43 @@ name: Test
on: on:
pull_request: pull_request:
branches: branches:
- master - master
push: push:
branches: [ master ] branches: [master]
jobs: jobs:
test: test:
name: Test name: Test
runs-on: ubuntu-18.04 runs-on: ubuntu-18.04
steps: steps:
- name: Set up Go 1.17
- name: Set up Golang uses: actions/setup-go@v2
uses: actions/setup-go@v1 with:
with: go-version: "1.17"
go-version: 1.17 id: go
id: go
- name: Check out code into the Go module directory
- name: Check out code into the Go module directory uses: actions/checkout@v2
uses: actions/checkout@v2 with:
with: submodules: "recursive"
submodules: 'recursive'
- name: Build static files
- name: Get dependencies run: |
run: | mkdir assets/build
go get github.com/rakyll/statik touch assets/build/test.html
export PATH=$PATH:~/go/bin/
statik -src=models -f - name: Test
run: go test -coverprofile=coverage.txt -covermode=atomic ./...
- name: Test
run: go test -coverprofile=coverage.txt -covermode=atomic ./... - name: Upload binary files (linux_arm)
uses: actions/upload-artifact@v2
- name: Upload binary files (linux_arm) with:
uses: actions/upload-artifact@v2 name: cloudreve_linux_arm
with: path: release/cloudreve*linux_arm.*
name: cloudreve_linux_arm
path: release/cloudreve*linux_arm.* - name: Upload binary files (linux_arm64)
uses: actions/upload-artifact@v2
- name: Upload binary files (linux_arm64) with:
uses: actions/upload-artifact@v2 name: cloudreve_linux_arm64
with: path: release/cloudreve*linux_arm64.*
name: cloudreve_linux_arm64
path: release/cloudreve*linux_arm64.*

5
.travis.yml
Unescape View File

@ -4,10 +4,9 @@ go:
node_js: "12.16.3" node_js: "12.16.3"
git: git:
depth: 1 depth: 1
install:
- go get github.com/rakyll/statik
before_script: before_script:
- statik -src=models -f - mkdir assets/build
- touch assets/build/test.html
script: script:
- go test -coverprofile=coverage.txt -covermode=atomic ./... - go test -coverprofile=coverage.txt -covermode=atomic ./...
after_success: after_success:

2
Dockerfile
Unescape View File

@ -28,8 +28,6 @@ RUN set -ex \
&& apk add gcc libc-dev git \ && apk add gcc libc-dev git \
&& export COMMIT_SHA=$(git rev-parse --short HEAD) \ && export COMMIT_SHA=$(git rev-parse --short HEAD) \
&& export VERSION=$(git describe --tags) \ && export VERSION=$(git describe --tags) \
&& (cd && go get github.com/rakyll/statik) \
&& statik -src=assets/build/ -include=*.html,*.js,*.json,*.css,*.png,*.svg,*.ico -f \
&& go install -ldflags "-X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=${VERSION}' \ && go install -ldflags "-X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=${VERSION}' \
-X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=${COMMIT_SHA}'\ -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=${COMMIT_SHA}'\
-w -s" -w -s"

16
README.md
Unescape View File

@ -68,7 +68,7 @@ chmod +x ./cloudreve
## :gear: 构建 ## :gear: 构建
自行构建前需要拥有 `Go >= 1.13`、`yarn`等必要依赖。 自行构建前需要拥有 `Go >= 1.17`、`yarn`等必要依赖。
#### 克隆代码 #### 克隆代码
@ -85,19 +85,7 @@ cd assets
yarn install yarn install
# 开始构建 # 开始构建
yarn run build yarn run build
```
#### 嵌入静态资源
```shell
# 回到项目主目录
cd ../
# 安装 statik, 用于嵌入静态资源
go get github.com/rakyll/statik
# 开始嵌入
statik -src=assets/build/ -include=*.html,*.js,*.json,*.css,*.png,*.svg,*.ico -f
``` ```
#### 编译项目 #### 编译项目
@ -108,7 +96,7 @@ export COMMIT_SHA=$(git rev-parse --short HEAD)
export VERSION=$(git describe --tags) export VERSION=$(git describe --tags)
# 开始编译 # 开始编译
go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'"
``` ```
你也可以使用项目根目录下的`build.sh`快速开始构建： 你也可以使用项目根目录下的`build.sh`快速开始构建：

141
bootstrap/static.go
Unescape View File

@ -1,21 +1,26 @@
package bootstrap package bootstrap
import ( import (
"bufio"
"embed"
"encoding/json" "encoding/json"
"io" "io"
"io/ioutil" "io/fs"
"net/http" "net/http"
"path" "path/filepath"
"github.com/pkg/errors"
"github.com/cloudreve/Cloudreve/v3/pkg/conf" "github.com/cloudreve/Cloudreve/v3/pkg/conf"
"github.com/cloudreve/Cloudreve/v3/pkg/util" "github.com/cloudreve/Cloudreve/v3/pkg/util"
_ "github.com/cloudreve/Cloudreve/v3/statik"
"github.com/gin-contrib/static" "github.com/gin-contrib/static"
"github.com/rakyll/statik/fs"
) )
const StaticFolder = "statics" const StaticFolder = "statics"
var StaticEmbed embed.FS
type GinFS struct { type GinFS struct {
FS http.FileSystem FS http.FileSystem
} }
@ -35,124 +40,100 @@ func (b *GinFS) Open(name string) (http.File, error) {
// Exists 文件是否存在 // Exists 文件是否存在
func (b *GinFS) Exists(prefix string, filepath string) bool { func (b *GinFS) Exists(prefix string, filepath string) bool {
if _, err := b.FS.Open(filepath); err != nil { if _, err := b.FS.Open(filepath); err != nil {
return false return false
} }
return true return true
} }
// InitStatic 初始化静态资源文件 // InitStatic 初始化静态资源文件
func InitStatic() { func InitStatic() {
var err error
if util.Exists(util.RelativePath(StaticFolder)) { if util.Exists(util.RelativePath(StaticFolder)) {
util.Log().Info("检测到 statics 目录存在，将使用此目录下的静态资源文件") util.Log().Info("检测到 statics 目录存在，将使用此目录下的静态资源文件")
StaticFS = static.LocalFile(util.RelativePath("statics"), false) StaticFS = static.LocalFile(util.RelativePath("statics"), false)
} else {
// 检查静态资源的版本 // 初始化静态资源
f, err := StaticFS.Open("version.json") embedFS, err := fs.Sub(StaticEmbed, "assets/build")
if err != nil {
util.Log().Warning("静态资源版本标识文件不存在，请重新构建或删除 statics 目录")
return
}
b, err := ioutil.ReadAll(f)
if err != nil { if err != nil {
util.Log().Warning("无法读取静态资源文件版本，请重新构建或删除 statics 目录") util.Log().Panic("无法初始化静态资源, %s", err)
return
} }
var v staticVersion StaticFS = &GinFS{
if err := json.Unmarshal(b, &v); err != nil { FS: http.FS(embedFS),
util.Log().Warning("无法解析静态资源文件版本, %s", err)
return
} }
}
// 检查静态资源的版本
f, err := StaticFS.Open("version.json")
if err != nil {
util.Log().Warning("静态资源版本标识文件不存在，请重新构建或删除 statics 目录")
return
}
staticName := "cloudreve-frontend" b, err := io.ReadAll(f)
if conf.IsPro == "true" { if err != nil {
staticName += "-pro" util.Log().Warning("无法读取静态资源文件版本，请重新构建或删除 statics 目录")
} return
}
if v.Name != staticName { var v staticVersion
util.Log().Warning("静态资源版本不匹配，请重新构建或删除 statics 目录") if err := json.Unmarshal(b, &v); err != nil {
return util.Log().Warning("无法解析静态资源文件版本, %s", err)
} return
}
if v.Version != conf.RequiredStaticVersion { staticName := "cloudreve-frontend"
util.Log().Warning("静态资源版本不匹配 [当前 %s, 需要: %s]，请重新构建或删除 statics 目录", v.Version, conf.RequiredStaticVersion) if conf.IsPro == "true" {
return staticName += "-pro"
} }
} else { if v.Name != staticName {
StaticFS = &GinFS{} util.Log().Warning("静态资源版本不匹配，请重新构建或删除 statics 目录")
StaticFS.(*GinFS).FS, err = fs.New() return
if err != nil {
util.Log().Panic("无法初始化静态资源, %s", err)
}
} }
if v.Version != conf.RequiredStaticVersion {
util.Log().Warning("静态资源版本不匹配 [当前 %s, 需要: %s]，请重新构建或删除 statics 目录", v.Version, conf.RequiredStaticVersion)
return
}
} }
// Eject 抽离内置静态资源 // Eject 抽离内置静态资源
func Eject() { func Eject() {
staticFS, err := fs.New() // 初始化静态资源
embedFS, err := fs.Sub(StaticEmbed, "assets/build")
if err != nil { if err != nil {
util.Log().Panic("无法初始化静态资源, %s", err) util.Log().Panic("无法初始化静态资源, %s", err)
} }
root, err := staticFS.Open("/") var walk func(relPath string, d fs.DirEntry, err error) error
if err != nil { walk = func(relPath string, d fs.DirEntry, err error) error {
util.Log().Panic("根目录不存在, %s", err)
}
var walk func(relPath string, object http.File)
walk = func(relPath string, object http.File) {
stat, err := object.Stat()
if err != nil { if err != nil {
util.Log().Error("无法获取[%s]的信息, %s, 跳过...", relPath, err) return errors.Errorf("无法获取[%s]的信息, %s, 跳过...", relPath, err)
return
} }
if !stat.IsDir() { if !d.IsDir() {
// 写入文件 // 写入文件
out, err := util.CreatNestedFile(util.RelativePath(StaticFolder + relPath)) out, err := util.CreatNestedFile(filepath.Join(util.RelativePath(""), StaticFolder, relPath))
defer out.Close() defer out.Close()
if err != nil { if err != nil {
util.Log().Error("无法创建文件[%s], %s, 跳过...", relPath, err) return errors.Errorf("无法创建文件[%s], %s, 跳过...", relPath, err)
return
} }
util.Log().Info("导出 [%s]...", relPath) util.Log().Info("导出 [%s]...", relPath)
if _, err := io.Copy(out, object); err != nil { obj, _ := embedFS.Open(relPath)
util.Log().Error("无法写入文件[%s], %s, 跳过...", relPath, err) if _, err := io.Copy(out, bufio.NewReader(obj)); err != nil {
return return errors.Errorf("无法写入文件[%s], %s, 跳过...", relPath, err)
} }
} else {
// 列出目录
objects, err := object.Readdir(0)
if err != nil {
util.Log().Error("无法步入子目录[%s], %s, 跳过...", relPath, err)
return
}
// 递归遍历子目录
for _, newObject := range objects {
newPath := path.Join(relPath, newObject.Name())
newRoot, err := staticFS.Open(newPath)
if err != nil {
util.Log().Error("无法打开对象[%s], %s, 跳过...", newPath, err)
continue
}
walk(newPath, newRoot)
}
} }
return nil
} }
util.Log().Info("开始导出内置静态资源...") // util.Log().Info("开始导出内置静态资源...")
walk("/", root) err = fs.WalkDir(embedFS, ".", walk)
if err != nil {
util.Log().Error("导出内置静态资源遇到错误：%s", err)
return
}
util.Log().Info("内置静态资源导出完成") util.Log().Info("内置静态资源导出完成")
} }

130
build.sh
Unescape View File

@ -1,13 +1,16 @@
#!/bin/bash #!/bin/bash
REPO=$(cd $(dirname $0); pwd) REPO=$(
cd $(dirname $0)
pwd
)
COMMIT_SHA=$(git rev-parse --short HEAD) COMMIT_SHA=$(git rev-parse --short HEAD)
VERSION=$(git describe --tags) VERSION=$(git describe --tags)
ASSETS="false" ASSETS="false"
BINARY="false" BINARY="false"
RELEASE="false" RELEASE="false"
debugInfo () { debugInfo() {
echo "Repo: $REPO" echo "Repo: $REPO"
echo "Build assets: $ASSETS" echo "Build assets: $ASSETS"
echo "Build binary: $BINARY" echo "Build binary: $BINARY"
@ -16,10 +19,9 @@ debugInfo () {
echo "Commit: $COMMIT_SHA" echo "Commit: $COMMIT_SHA"
} }
buildAssets () { buildAssets() {
cd $REPO cd $REPO
rm -rf assets/build rm -rf assets/build
rm -f statik/statik.go
export CI=false export CI=false
@ -27,94 +29,88 @@ buildAssets () {
yarn install yarn install
yarn run build yarn run build
cd build
if ! [ -x "$(command -v statik)" ]; then rm -rf *.map
export CGO_ENABLED=0
go get github.com/rakyll/statik
fi
cd $REPO
statik -src=assets/build/ -include=*.html,*.js,*.json,*.css,*.png,*.svg,*.ico,*.ttf -f
} }
buildBinary () { buildBinary() {
cd $REPO cd $REPO
go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'"
} }
_build() { _build() {
local osarch=$1 local osarch=$1
IFS=/ read -r -a arr <<<"$osarch" IFS=/ read -r -a arr <<<"$osarch"
os="${arr[0]}" os="${arr[0]}"
arch="${arr[1]}" arch="${arr[1]}"
gcc="${arr[2]}" gcc="${arr[2]}"
# Go build to build the binary. # Go build to build the binary.
export GOOS=$os export GOOS=$os
export GOARCH=$arch export GOARCH=$arch
export CC=$gcc export CC=$gcc
export CGO_ENABLED=1 export CGO_ENABLED=1
if [ -n "$VERSION" ]; then if [ -n "$VERSION" ]; then
out="release/cloudreve_${VERSION}_${os}_${arch}" out="release/cloudreve_${VERSION}_${os}_${arch}"
else else
out="release/cloudreve_${COMMIT_SHA}_${os}_${arch}" out="release/cloudreve_${COMMIT_SHA}_${os}_${arch}"
fi fi
go build -a -o "${out}" -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" go build -a -o "${out}" -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'"
if [ "$os" = "windows" ]; then if [ "$os" = "windows" ]; then
mv $out release/cloudreve.exe mv $out release/cloudreve.exe
zip -j -q "${out}.zip" release/cloudreve.exe zip -j -q "${out}.zip" release/cloudreve.exe
rm -f "release/cloudreve.exe" rm -f "release/cloudreve.exe"
else else
mv $out release/cloudreve mv $out release/cloudreve
tar -zcvf "${out}.tar.gz" -C release cloudreve tar -zcvf "${out}.tar.gz" -C release cloudreve
rm -f "release/cloudreve" rm -f "release/cloudreve"
fi fi
} }
release(){ release() {
cd $REPO cd $REPO
## List of architectures and OS to test coss compilation. ## List of architectures and OS to test coss compilation.
SUPPORTED_OSARCH="linux/amd64/gcc linux/arm/arm-linux-gnueabihf-gcc windows/amd64/x86_64-w64-mingw32-gcc linux/arm64/aarch64-linux-gnu-gcc" SUPPORTED_OSARCH="linux/amd64/gcc linux/arm/arm-linux-gnueabihf-gcc windows/amd64/x86_64-w64-mingw32-gcc linux/arm64/aarch64-linux-gnu-gcc"
echo "Release builds for OS/Arch/CC: ${SUPPORTED_OSARCH}" echo "Release builds for OS/Arch/CC: ${SUPPORTED_OSARCH}"
for each_osarch in ${SUPPORTED_OSARCH}; do for each_osarch in ${SUPPORTED_OSARCH}; do
_build "${each_osarch}" _build "${each_osarch}"
done done
} }
usage() { usage() {
echo "Usage: $0 [-a] [-c] [-b] [-r]" 1>&2; echo "Usage: $0 [-a] [-c] [-b] [-r]" 1>&2
exit 1; exit 1
} }
while getopts "bacr:d" o; do while getopts "bacr:d" o; do
case "${o}" in case "${o}" in
b) b)
ASSETS="true" ASSETS="true"
BINARY="true" BINARY="true"
;; ;;
a) a)
ASSETS="true" ASSETS="true"
;; ;;
c) c)
BINARY="true" BINARY="true"
;; ;;
r) r)
ASSETS="true" ASSETS="true"
RELEASE="true" RELEASE="true"
;; ;;
d) d)
DEBUG="true" DEBUG="true"
;; ;;
*) *)
usage usage
;; ;;
esac esac
done done
shift $((OPTIND-1)) shift $((OPTIND - 1))
if [ "$DEBUG" = "true" ]; then if [ "$DEBUG" = "true" ]; then
debugInfo debugInfo

2
go.mod
Unescape View File

@ -1,6 +1,6 @@
module github.com/cloudreve/Cloudreve/v3 module github.com/cloudreve/Cloudreve/v3
go 1.13 go 1.17
require ( require (
github.com/DATA-DOG/go-sqlmock v1.3.3 github.com/DATA-DOG/go-sqlmock v1.3.3

4
main.go
Unescape View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"embed"
"flag" "flag"
"github.com/cloudreve/Cloudreve/v3/bootstrap" "github.com/cloudreve/Cloudreve/v3/bootstrap"
@ -15,6 +16,9 @@ var (
scriptName string scriptName string
) )
//go:embed assets/build
var StaticEmbed embed.FS
func init() { func init() {
flag.StringVar(&confPath, "c", util.RelativePath("conf.ini"), "配置文件路径") flag.StringVar(&confPath, "c", util.RelativePath("conf.ini"), "配置文件路径")
flag.BoolVar(&isEject, "eject", false, "导出内置静态资源") flag.BoolVar(&isEject, "eject", false, "导出内置静态资源")

1
pkg/util/path.go
Unescape View File

@ -56,3 +56,4 @@ func RelativePath(name string) string {
e, _ := os.Executable() e, _ := os.Executable()
return filepath.Join(filepath.Dir(e), name) return filepath.Join(filepath.Dir(e), name)
} }

Write Preview
Loading…
Cancel
Save