Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreburgaud/meetup-golang-embed
Code supporting the 8/18/2021 GoMN meetup: Usage of Go embed directive
https://github.com/andreburgaud/meetup-golang-embed
config embed go web
Last synced: 3 months ago
JSON representation
Code supporting the 8/18/2021 GoMN meetup: Usage of Go embed directive
- Host: GitHub
- URL: https://github.com/andreburgaud/meetup-golang-embed
- Owner: andreburgaud
- Created: 2021-08-18T14:54:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-19T02:55:02.000Z (about 3 years ago)
- Last Synced: 2024-06-21T17:03:58.056Z (5 months ago)
- Topics: config, embed, go, web
- Language: Go
- Homepage: https://www.meetup.com/golangmn/events/280071866/
- Size: 215 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-golang-repositories - meetup-golang-embed
README
# Golang Embed
## What I like in Go
* Fast Compilation
* Simple Language (*)
* Cross compilation
* Complete and Reliable Standard Library
* **Single Executable**
## Embed
Available since **Go 1.16**
From https://pkg.go.dev/embed#hdr-Directives:
> Package `embed` provides access to files embedded in the running Go program.
> Go source files that import `embed` can use the `//go:embed` directive to initialize a variable of type `string`, `[]byte`, or `FS` with the **contents of files** read from the package directory or subdirectories at **compile time**.
* Variable of type `string`
* Variable fo type `[]byte` for an individual file
* Variable of type `embed.FS` for an individual file or a group of files
## Examples
### 1 - Hello Example
* Variable of type `string`
```go
...
import (
_ "embed" // Import embed for its side effect (//go:embed directive)
)
//go:embed hello.txt
var hello string
...
```
### 2 - License Example
* Variable of type `[]byte`
```go
...
import (
_ "embed"
)
//go:embed MIT.txt
var license []byte
...
```
### 3 - Config Example
* Variable of type `embed.FS` (with a single file)
```go
//go:embed config.json
var f embed.FS
func main() {
data, _ := f.ReadFile("config.json")
...
```
### 4 - Static Web Site Example
* Variable of type `embed.FS` (with a subdirectory)
```go
...
//go:embed static
var static embed.FS
func main() {
// Sub() returns a FS interface corresponding
// to the content of the `static` sub directory
fsys, _ := fs.Sub(static, "static")
// http.FS convert an FS implementation
// Corresponds to http.Dir("/static") of operating file system
http.Handle("/", http.FileServer(http.FS(fsys)))
http.ListenAndServe(":8888", nil)
}
```
### 5 - Embedded Lua Example
* https://github.com/andreburgaud/meetup-golang-lua
```go
import (
_ "embed"
lua "github.com/yuin/gopher-lua"
)
//go:embed script.lua
var script string
func main() {
L := lua.NewState() // Open Lua
defer L.Close()
L.DoString(script) // Execute Lua string
}
```
## Build the Examples
To build the examples, you can look at the `justfile` in each directory and execute the corresponding `go build` command.
If you want to get the build automation provided by `just`, you can install this tool available at https://github.com/casey/just. A `justfile` is comparable to a `Makefile` without the drawback of it.
For example on a Mac, you can install `just` with [Homebrew](https://brew.sh/) as follows:
```
$ brew install just
```
To build all the examples in this repository, you can subsequently, execute the following command at the root of the project:
```
$ just build
```
This command will execute the `just` file in each respective example directory. Alternatively, you can also execute `just build` in each example directory containing Go code.
The builds generate the output, a single executable, in a subdirectory `out`, in each example folder. This is intentional to demonstrate that the executables contain all the static resources without reying on the static files in the file system.
Checkout [just documentation](https://github.com/casey/just/blob/master/README.adoc) for more details.
## Resources
* https://pkg.go.dev/embed
* https://bhupesh-v.github.io/embedding-static-files-in-golang/
* https://blog.carlmjohnson.net/post/2021/how-to-use-go-embed/
* https://github.com/carlmjohnson/exembed/
* https://blog.jetbrains.com/go/2021/06/09/how-to-use-go-embed-in-go-1-16/
* https://lakefs.io/working-with-embed-in-go/
* https://echorand.me/posts/go-embed/