This document discusses Go web development using the Gin web framework. It provides an overview of Gin's features and file structure conventions. It also describes using Orator ORM for database migrations in Go applications. Benchmark results show the json-iterator library provides better JSON performance than the standard encoding/json package in Go. The document concludes with recommendations for Nginx SSL and security header parameters.

1. Go Web Development
erinus@MuzikOnline
2017.07.06

2. Web

3. Gin
https://github.com/gin-gonic/gin
written in Go

4. Gin
• appleboy
•
•
•

5. /assets Binary File System bindata
/files *.css, *.js, *.png, ...
/pages *.tpl
/claims JSON Web Token
/models Database Table Schema
/protos Post Body Form Body & JSON Body
/routes Routes
/api API Controllers
/web Web Controllers

6. /assets.go Binary File System bindata
/Makefile Makefile
/reboot.sh Zero-Downtime
/server.go Entry Point
/static.go Binary File System & MultiTemplate

7. github.com/gin-gonic/gin
Gin
github.com/gin-contrib/multitemplate
Gin
github.com/gin-contrib/sessions
Gin Session

8. github.com/gin-contrib/secure
Gin
github.com/gin-contrib/static
Gin
github.com/utrack/gin-csrf
Gin CSRF

9. github.com/facebookgo/grace/gracehttp
github.com/go-sql-driver/mysql
MySQL Database Driver

10. STD = log.New(os.Stdout, "[STD] ",
log.Ldate|log.Ltime|log.Lshortfile)
DBG = log.New(os.Stdout, "[DBG] ",
log.Ldate|log.Ltime|log.Lshortfile)
ERR = log.New(os.Stdout, "[ERR] ",
log.Ldate|log.Ltime|log.Lshortfile)

11. Connection Instance
var db *sql.DB
db, err = sql.Open("mysql",
"[username]:[password]@tcp([hostname]:3306)/[database]
?charset=utf8&parseTime=true")
if err != nil { ... }
defer db.Close()

12. var helper template.FuncMap
helper = template.FuncMap{
"PrefixBelongRoutes": func(ctx *gin.Context
routes ...string) bool { ... },
"BelongRoutes": func(ctx *gin.Context,
routes ...string) bool { ... },
}

13. var render multitemplate.Render
render = multitemplate.New()
render.Add("login", GetTPL(helper,
"pages/app.tpl", "pages/login.tpl"))
render.Add("index", GetTPL(helper,
"pages/app.tpl", "pages/index.tpl"))

14. Session Cookie
var cookie sessions.CookieStore
cookie = sessions.NewCookieStore([]byte([secret]))
cookie.Options(sessions.Options{
Path: "/",
Secure: true,
HttpOnly: true,
})

15. Gin
var router *gin.Engine
router = gin.Default()

16. P.11
router.HTMLRender = render

17. router.Use(secure.New(secure.Config{
AllowedHosts: []string{},
SSLRedirect: true,
SSLTemporaryRedirect: true,
SSLHost: "",
STSSeconds: 315360000,
STSIncludeSubdomains: true,

18. FrameDeny: true,
CustomFrameOptionsValue: "",
ContentTypeNosniff: true,
BrowserXssFilter: true,
ContentSecurityPolicy: "default-src 'self'",
IsDevelopment: true,
}))

19. router.Use(static.Serve("/files", GetBFS("assets/files")))
Session
router.Use(sessions.Sessions("[session-key]", cookie))

20. router.Use(static.Serve("/files", GetBFS("assets/files")))

21. CSRF
router.Use(csrf.Middleware(csrf.Options{
Secret: [secret],
ErrorFunc: func(ctx *gin.Context) {
ctx.Abort()
},
IgnoreRoutes: []string{ ... },
}))

22. API
func ApiAuthRequired() gin.HandlerFunc {
return func(ctx *gin.Context) {
// validate from JSON Web Token
ctx.Next()
}
}

23. Web
func WebAuthRequired() gin.HandlerFunc {
return func(ctx *gin.Context) {
// validate from Session
ctx.Next()
}
}

24. API Route
var api *gin.RouterGroup
api = router.Group("/api")
{ /* API Controllers */ }
api.Use(ApiAuthRequired())
{ /* API Controllers */ }

25. Web Route
var web *gin.RouterGroup
web = router.Group("/")
{ /* Web Controllers */ }
web.Use(WebAuthRequired())
{ /* Web Controllers */ }

26. SSL
var x509 tls.Certificate
x509, err = tls.LoadX509KeyPair([crt-path], [key-path])

27. HTTP
var server *http.Server
server = &http.Server{
Addr: fmt.Sprintf("%s:%d", HOST, PORT),
Handler: router,
TLSConfig: &tls.Config{
Certificates: []tls.Certificate{ x509 },
},
}

28. HTTP
gracehttp.Serve(server)

29. Makefile
default:
@go build -o [output] *.go
all:
@go-bindata -o assets.go assets/...
@go build -o [output] *.go

30. reboot.sh
#!/bin/sh
ps aux | grep [output]
echo "Reloading..."
sudo kill -USR2 $(ps aux | grep [output] | awk 'NR==1{ print $2 }')
echo "Reloaded"
sleep 2
ps aux | grep [output]

31. Controller
Register
api = router.Group("/")
{
apiroutes.Login(api)
}

32. Controller
API Controllers
Package apiroutes
func Login(router *gin.RouterGroup) {
router.POST("/login", func(ctx *gin.Context) {
// get data from db and validation
ctx.JSON(http.StatusOK, gin.H{ "uid": uid, })
}
}

33. Controller
Register
web = router.Group("/")
{
webroutes.Index(web)
}

34. Controller
Web Controllers
Package webroutes
func Index(router *gin.RouterGroup) {
router.GET("/", func(ctx *gin.Context) {
// get data from db
ctx.HTML(http.StatusOK, "index", gin.H{ "uid": uid, })
}
}

35. Database

36. •
Continous Integration
•
Ant DBA
1.
revisions migration
2.

37. Orator
https://orator-orm.com
written in Python

38. Orator
•
•
•
•
•
•

39. Orator Migrations
orator.py
DATABASES = {
'mysql': {
'driver': 'mysql',
'host': '[hostname]',
'database': '[database]',
'user': '[username]',
'password': '[password]',
'prefix': ''

40. Orator Migrations
migrations

41. Orator Migrations
migration
> orator make:migration create_users_table
migrations/[timstamp]_create_users_table.py
> orator make:migration modify_users_table
migrations/[timstamp]_modify_users_table.py

42. Orator Migrations
migrations
> orator migrate

43. Orator Migrations
migrations
> orator migrate:rollback

44. Migration Code
create_users_table
class CreateUsersTable(Migration):
def up(self):
if not self.schema.has_table('users'):
with self.schema.create('users') as table:
table.charset = 'utf8mb4'
table.collation = 'utf8mb4_unicode_ci'
table.increments('id')

45. Migration Code
create_users_table
table.integer('type').unsigned()
table.string('name', 128)
table.string('desc', 512)
table.string('uuid').unique()
table.timestamps()
table.soft_deletes()

46. Migration Code
create_users_table
def down(self):
self.schema.drop_if_exists('users')

47. Migration Code
modify_users_table
class ModifyUsersTable(Migration):
def up(self):
if not self.schema.has_table('users'):
with self.schema.table('users') as table:
table.integer('created_user').after('created_at')
table.integer('updated_user').after('updated_at’)
table.integer('deleted_user').nullable()
.after('deleted_at')

48. Migration Code
modify_users_table
def down(self):
if not self.schema.has_table('users'):
with self.schema.table('users') as table:
table.drop_column('created_user')
table.drop_column('updated_user')
table.drop_column('deleted_user')

49. Migration Code
modify_users_table
class ModifyUsersTable(Migration):
def up(self):
if not self.schema.has_table('users'):
with self.schema.table('users') as table:
table.drop_unique('%s_%s_%s' %
('users', 'uuid', 'unique'))
table.rename_column('uuid', 'user_uuid')
table.unique('user_uuid')

50. Migration Code
modify_users_table
def down(self):
if not self.schema.has_table('users'):
with self.schema.table('users') as table:
table.drop_unique('%s_%s_%s' %
('users', 'user_uuid', 'unique'))
table.rename_column('uuid_uuid', 'user')
table.unique('user')

51. Orator Go
tablenames =
[table.values()[0] for table in db.select('show tables')]
tablenames.remove('migrations')

52. Orator Go
columns = db.select('show columns from %s' % tablename)

53. Orator Go
•
•
depart_users users_groups
•
users groups
•
1:N depart_users
M:N users_groups
Go
•
•
DepartUsers UsersGroups
•
Users Groups
•
1:N DepartUsers
M:N UsersGroups

54. Orator Go
• char, varchar, text
• Timestamp
• short, int, long
Go
• sql.NullString
database/sql
• mysql.NullTime
github.com/go-sql-driver/mysql
• sql.NullInt64
database/sql

55. Orator ---> Database
---> Orator ---> Go Structs
---> Models, Protos
---> GinAnt

56. JSON

57. Go
encoding/json
github.com/json-iterator/go

58. github.com/json-iterator/go
•
•

59. • import "encoding/json“
• json.Marhsal
• json.Unmarhsal
• import "github.com/json-
iterator/go"
• jsoniter.Marshal
• jsoniter.Unmarshal

60. • Host
• 32 Cores (Intel Xeon CPU E5-2630 v3)
• 64 GB Memory
• VMware Workstation Pro 12.5.2
• Guest
• 4 Cores CPU
• 4 GB Memory
• Ubuntu Desktop 16.04.1
• Go 1.8.3 linux/amd64

61. • Go
encoding/json
•
github.com/json-iterator/go

62. type User struct {
ID int
Name string
Phones []string
Address UserAddress
}
type UserAddress struct {
Country int
City int
Line1 string
Line2 string
}

63. Marshal User{
ID: 1,
Name: "erinus",
Phones: []string{
"0975733983",
"0955773991",
},
}

64. encoding/json
2719.660506ms
github.com/json-iterator/go
1387.888566ms
1.9x

65. Marshal Array[
User{
ID: 1,
Name: "erinus",
Phones: []string{
"0975733983",
"0955773991",
},
},
repeat 100 times ...
]

66. encoding/json
244374.287138ms
github.com/json-iterator/go
83927.606927ms
2.9x

67. Marshal User{
ID: 1,
Name: "erinus",
Phones: []string{
"0975733983",
"0955773991",
},
Address: UserAddress{
Country: 886,
City: 12,
Line1: "13F., No.53, Ln. 118, Renhua St.,",
Line2: "Sanchong Dist., New Taipei City",
},
}

68. encoding/json
3906.035542ms
github.com/json-iterator/go
1494.293775ms
2.6x

69. Unmarshal {
"ID": 1,
"Name": "erinus",
"Phones":[
"0975733983",
"0955773991"
]
}

70. encoding/json
4191.640775ms
github.com/json-iterator/go
901.676825ms
4.6x

71. Unmarshal [
{
"ID": 1,
"Name": "erinus",
"Phones":[
"0975733983",
"0955773991"
]
},
repeat 100 times ...
]

72. encoding/json
256959.848113ms
github.com/json-iterator/go
52141.368106ms
4.9x

73. Unmarshal {
"ID": 1,
"Name": "erinus",
"Phones":[
"0975733983",
"0955773991"
],
"Address": {
"Country": 886,
"City": 12,
"Line1": "13F., No.53, Ln. 118, Renhua St.,",
"Line2": "Sanchong Dist., New Taipei City"
}
}

74. encoding/json
8112.072724ms
github.com/json-iterator/go
1627.580308ms
4.9x

75. NGINX SSL Parameters
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_prefer_server_ciphers on;
ssl_ciphers 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-
GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-
POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-
SHA256:ECDHE-ECD SA-AES256-SHA384:ECDHE-RSA-AES256-
SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:DHE-
RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:ECDHE-RSA-
AES128-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AE S128-SHA';

76. NGINX SSL Parameters
ssl_ecdh_curve secp384r1;
ssl_session_cache shared:SSL:50m;
ssl_session_timeout 1d;
ssl_session_tickets off;
ssl_stapling on;
ssl_stapling_verify on;
resolver 8.8.8.8 8.8.4.4 valid=300s;
resolver_timeout 5s;
Ant
DNS
DNS

77. NGINX SSL Parameters
add_header Strict-Transport-Security "max-age=63072000;
includeSubDomains; preload";
add_header X-Frame-Options DENY;
add_header X-Content-Type-Options nosniff;
Ant HTTP Headers
HTTP Headers

78. Q & A

79. Thanks >.-