Gin 框架快速创建静态文件下载Web服务

 更新时间:2021年12月10日 10:17:11   作者:尹东勋  
本文主要介绍了Gin 框架快速创建静态文件下载Web服务,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

介绍

本文介绍如何通过 rk-boot 快速搭建静态文件下载 Web 服务。

什么是 静态文件下载 Web UI?

通过配置文件,快速搭建可下载文件的 Web 服务。

请访问如下地址获取完整教程:

rkdocs.netlify.app/cn

安装

go get github.com/rookie-ninja/rk-boot

快速开始

rk-boot 提供了一个方便的方法,让用户快速实现网页【浏览和下载】静态文件的功能。

目前,rk-boot 支持如下文件源。如果用户希望支持更多的文件源,可以通过实现 http.FileSystem 接口来实现。

  • 本地文件系统
  • pkger

1.创建 boot.yaml

---
gin:
  - name: greeter                     # Required
    port: 8080                        # Required
    enabled: true                     # Required
    static:
      enabled: true                   # Optional, default: false
      path: "/rk/v1/static"           # Optional, default: /rk/v1/static
      sourceType: local               # Required, options: pkger, local
      sourcePath: "."                 # Required, full path of source directory

2.创建 main.go

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main

import (
 "context"
 "github.com/rookie-ninja/rk-boot"
)

// Application entrance.
func main() {
 // Create a new boot instance.
 boot := rkboot.NewBoot()

 // Bootstrap
 boot.Bootstrap(context.Background())

 // Wait for shutdown sig
 boot.WaitForShutdownSig(context.Background())
}

3.文件夹结构

.
├── boot.yaml
├── go.mod
├── go.sum
└── main.go

0 directories, 4 files

4.验证

访问 http://localhost:8080/rk/v1/static

从 pkger 读取文件 (嵌入式静态文件)

pkger 是一个可以把静态文件,嵌入到 .go 文件的工具。

这个例子中,我们把当前文件夹下的所有文件,都嵌入到 pkger.go 文件中。

这样做的好处就是,在部署的时候,可以不用考虑复制一堆文件夹结构。

1.下载 pkger 命令行

go get github.com/markbates/pkger/cmd/pkger

2.创建 boot.yaml

pkger 会使用 module 来区分不同的 package,所以,sourcePath 里,我们添加了相应 module 的前缀。

---
gin:
  - name: greeter                                             # Required
    port: 8080                                                # Required
    enabled: true                                             # Required
    static:
      enabled: true                                           # Optional, default: false
      path: "/rk/v1/static"                                   # Optional, default: /rk/v1/static
      sourceType: pkger                                       # Required, options: pkger, local
      sourcePath: "github.com/rookie-ninja/rk-demo:/"         # Required, full path of source directory

3.创建 main.go

代码中,有两个地方需要注意。

pkger.Include("./")
这段代码不做任何事情,是告诉 pkger 命令行打包哪些文件。

_ “github.com/rookie-ninja/rk-demo/internal”
一定要这么引入,因为我们会把 pkger.go 文件放到 internal/pkger.go 中,pkger.go 文件里定一个一个 variable,只有这么引入,才可以在编译 main.go 的时候,顺利引入 variable。

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main

import (
 "context"
 "github.com/markbates/pkger"
 "github.com/rookie-ninja/rk-boot"
 // Must be present in order to make pkger load embedded files into memory.
 _ "github.com/rookie-ninja/rk-demo/internal"
)

func init() {
 // This is used while running pkger CLI
 pkger.Include("./")
}

// Application entrance.
func main() {
 // Create a new boot instance.
 boot := rkboot.NewBoot()

 // Bootstrap
 boot.Bootstrap(context.Background())

 // Wait for shutdown sig
 boot.WaitForShutdownSig(context.Background())
}

4.生成 pkger.go

pkger -o internal

5.文件夹结构

.
├── boot.yaml
├── go.mod
├── go.sum
├── internal
│   └── pkged.go
└── main.go

1 directory, 5 files

6.验证

访问 http://localhost:8080/rk/v1/static

自定义文件源

我们将使用 afero package 里面的 memFs 作为例子。

如果想要从类似 AWS S3 中读取,用户可以实现一个属于自己的 http.FileSystem。

rk-boot 会在后续的更新中,逐渐实现这些功能。

1.创建 boot.yaml

---
gin:
  - name: greeter                     # Required
    port: 8080                        # Required
    enabled: true                     # Required

2.创建 main.go

我们在 memFs 中创建了一个 /folder 文件夹和 一个 /file.txt 文件。

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main

import (
 "context"
 "github.com/rookie-ninja/rk-boot"
 "github.com/rookie-ninja/rk-gin/boot"
 "github.com/spf13/afero"
 "os"
)

// Application entrance.
func main() {
 // Create a new boot instance.
 boot := rkboot.NewBoot()

 // Create a memory fs
 fs := afero.NewHttpFs(afero.NewMemMapFs())

 // Add folder and file.txt into memory fs
 fs.MkdirAll("/folder", os.ModePerm)
 f, _ := fs.Create("/file.txt")
 f.Write([]byte("this is my content!"))
 f.Close()

 // Set StaticFileEntry
 ginEntry := boot.GetGinEntry("greeter")
 ginEntry.StaticFileEntry = rkgin.NewStaticFileHandlerEntry(
  rkgin.WithPathStatic("/rk/v1/static"),
  rkgin.WithFileSystemStatic(fs))

 // Bootstrap
 boot.Bootstrap(context.Background())

 // Wait for shutdown sig
 boot.WaitForShutdownSig(context.Background())
}

3.验证

访问 http://localhost:8080/rk/v1/static

到此这篇关于Gin 框架快速创建静态文件下载Web服务的文章就介绍到这了,更多相关Gin静态文件下载内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang:json 反序列化的[]和nil操作

    golang:json 反序列化的[]和nil操作

    这篇文章主要介绍了golang:json 反序列化的[]和nil操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Go中gin框架的*gin.Context参数常见实用方法

    Go中gin框架的*gin.Context参数常见实用方法

    *gin.Context是处理HTTP请求的核心,ctx代表"context"(上下文),它包含了处理请求所需的所有信息和方法,例如请求数据、响应构建器、路由参数等,这篇文章主要介绍了Go中gin框架的*gin.Context参数常见实用方法,需要的朋友可以参考下
    2024-07-07
  • 基于Golang实现Excel表格的导入导出功能

    基于Golang实现Excel表格的导入导出功能

    最近项目开发中有涉及到Excel的导入与导出功能,特别是导出表格时需要特定的格式,所以本文给大家介绍了基于Golang实现Excel表格的导入导出功能,文中通过代码示例和图文介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • Golang logrus 日志包及日志切割的实现

    Golang logrus 日志包及日志切割的实现

    这篇文章主要介绍了Golang logrus 日志包及日志切割的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02
  • Golang如何读取单行超长的文本详解

    Golang如何读取单行超长的文本详解

    这篇文章主要给大家介绍了关于Golang如何读取单行超长文本的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2021-12-12
  • Go语言使用Etcd实现分布式锁

    Go语言使用Etcd实现分布式锁

    etcd是近几年比较火热的一个开源的、分布式的键值对数据存储系统,本文将介绍如何利用Etcd实现分布式锁,感兴趣的小伙伴可以跟随小编一起了解一下
    2023-05-05
  • 一文带你掌握Golang中的类型断言

    一文带你掌握Golang中的类型断言

    类型断言是 Golang 中的一个非常重要的特性,使用类型断言可以判断一个接口的实际类型是否是预期的类型,以便进行对应的处理,下面就跟随小编一起深入了解一下Golang中的类型断言吧
    2024-01-01
  • go语言if/else语句简单用法示例

    go语言if/else语句简单用法示例

    这篇文章主要介绍了go语言if/else语句用法,结合实例形式分析了go语言if else语句的判定与流程控制技巧,需要的朋友可以参考下
    2016-05-05
  • Go语言操作MySQL的知识总结

    Go语言操作MySQL的知识总结

    Go语言中的database/sql包提供了保证SQL或类SQL数据库的泛用接口,并不提供具体的数据库驱动。本文介绍了Go语言操作MySQL的相关知识,感兴趣的可以了解一下
    2022-11-11
  • golang context接口类型方法介绍

    golang context接口类型方法介绍

    这篇文章主要为大家介绍了golang context接口类型方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09

最新评论