gin
是简单快速的golang
框架,这篇文章主要是介绍gin
的路由配置及使用(主要是post方法)
func setStaticFS(r *gin.Engine) {
r.LoadHTMLGlob("views/*")
r.StaticFS("/static", http.Dir("public/static"))
r.StaticFS("/upload", http.Dir("upload"))
}
func (engine *Engine) LoadHTMLGlob(pattern string)
函数加载全局模式的HTML文件标识,并将结果与HTML渲染器相关联。
func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes
设置相对路径的静态资源
api路由分组
api := r.Group("/api")
{
api.POST("/form_post", formPost)
api.POST("/json_post", jsonPost)
api.POST("/urlencoded_post", urlencodedPost)
api.POST("/json_and_form_post", jsonAndFormPost)
api.POST("/xml_post", xmlPost)
api.POST("/file_upload", fileUpload)
api.GET("/list", func(c *gin.Context) {
message := c.Query("message")
nick := c.DefaultQuery("nick", "anonymous")
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"message": message,
"nick": nick,
})
})
}
常用请求Headers
中Content-Type
的类型有text/plain
、text/html
、application/json
、application/x-www-form-urlencoded
、application/xml
和multipart/form-data
等.
text/plain
纯文本text/html
HTML文档application/json
json格式数据application/x-www-form-urlencoded
使用HTTP的POST方法提交的表单application/xml
xml格式数据application/form-data
主要是用来上传文件
gin 路由实现
api.POST("/form_post", formPost)
// 表单提交
func formPost(c *gin.Context) {
message := c.PostForm("message")
nick := c.DefaultPostForm("nick", "anonymous") // 没有获取到nick值时给一个默认值
log.Println(message, nick)
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"message": message,
"nick": nick,
})
}
html实现
<form method="post" action="/api/form_post">
<input type="text" name="message">
<input type="text" name="nick">
<button type="submit">提交</button>
</form>
gin 路由实现
type User struct {
Name string `json:"name" form:"name"`
Message string `json:"message" form:"message"`
Nick string `json:"nick" form:"nick"`
}
func jsonPost(c *gin.Context) {
var user User
c.BindJSON(&user)
log.Println(user.Name, user.Message, user.Nick)
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"name": user.Name,
"message": user.Message,
"nick": user.Nick,
})
}
js实现
$('.json').on('click', function() {
axios({
method: 'post',
url: '/api/json_post',
headers: {
'Content-Type': 'application/json'
},
data
}).then(res => {
console.log(res.data)
$('.json-msg').text(`success ${new Date()}`)
})
})
gin实现
// application/x-www-form-urlencoded
func urlencodedPost(c *gin.Context) {
name := c.Query("name")
message := c.PostForm("message")
nick := c.DefaultPostForm("nick", "1231412")
log.Println(name, message, nick)
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"name": name,
"message": message,
"nick": nick,
})
}
js实现
$('.urlencoded').on('click', function() {
var data = {}
var inputs = $('#form input')
for (let i = 0; i < inputs.length; i ++) {
data[$(inputs[i]).attr('name')] = $(inputs[i]).val()
}
axios({
method: 'post',
url: '/api/urlencoded_post?name=shineshao',
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
},
data: $.param(data)
}).then(res => {
console.log(res.data)
$('.urlencoded-msg').text(`success ${new Date()}`)
})
})
gin
type User struct {
Name string `json:"name" form:"name"`
Message string `json:"message" form:"message"`
Nick string `json:"nick" form:"nick"`
}
// application/json application/x-www-form-urlencoded
func jsonAndFormPost(c *gin.Context) {
var user User
c.Bind(&user)
log.Println(user.Name, user.Message, user.Nick)
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"name": user.Name,
"message": user.Message,
"nick": user.Nick,
})
}
js 实现
$('.jsonandform').on('click', function() {
var data = {}
var inputs = $('#form input')
for (let i = 0; i < inputs.length; i ++) {
data[$(inputs[i]).attr('name')] = $(inputs[i]).val()
}
axios({
method: 'post',
url: '/api/json_and_form_post',
headers: {
'Content-Type': 'application/json'
},
data
}).then(res => {
console.log(res.data)
$('.jsonandform-msg').text(`success application/json data, ${new Date()}`)
})
})
$('.jsonandform2').on('click', function() {
var data = {}
var inputs = $('#form input')
for (let i = 0; i < inputs.length; i ++) {
data[$(inputs[i]).attr('name')] = $(inputs[i]).val()
}
axios({
method: 'post',
url: '/api/json_and_form_post',
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
},
data:$.param(data)
}).then(res => {
console.log(res.data)
$('.jsonandform-msg').text(`success application/x-www-form-urlencoded data${new Date()}`)
})
})
gin 实现
type User struct {
Name string `json:"name" form:"name" xml:"name"`
Message string `json:"message" form:"message" xml:"message"`
Nick string `json:"nick" form:"nick" xml:"nick"`
}
func xmlPost(c *gin.Context) {
var user User
c.Bind(&user)
log.Println(user.Name, user.Message, user.Nick)
c.JSON(http.StatusOK, gin.H{
"status": "SUCCESS",
"name": user.Name,
"message": user.Message,
"nick": user.Nick,
})
}
js 实现
$('.xml_post').on('click', function() {
var data = {}
var inputs = $('#form input')
for (let i = 0; i < inputs.length; i ++) {
data[$(inputs[i]).attr('name')] = $(inputs[i]).val()
}
axios({
method: 'post',
url: '/api/xml_post',
headers: {
"Content-Type": 'application/xml'
},
data: `<xml><name>${data.name}</name><message>${data.message}</message><nick>${data.nick}</nick></xml>`
})
})
gin实现文件上传
func fileUpload(c *gin.Context) {
filesUrl := make([]string, 0)
form, err := c.MultipartForm()
if err != nil {
log.Println("postMultipleFile error: %s")
}
files := form.File["file"]
_, err = os.Stat("upload")
if err != nil {
os.Mkdir("upload", os.ModePerm)
}
for _, file := range files {
log.Println(file.Filename)
// Upload the file to specific dst.
if err = c.SaveUploadedFile(file, "upload/"+file.Filename); err != nil {
log.Println("SaveUploadedFile error: %s")
return
}
filesUrl = append(filesUrl, "upload/"+file.Filename)
}
c.JSON(http.StatusOK, gin.H{
"state": "SUCCESS",
"url": strings.Join(filesUrl, ";"),
})
}
html实现
<div>
<form id="multipleForm">
<input type="file" name="file" id='file' multiple="multiple" accept="image/*">
</form>
<button class="file_upload">上传文件</button>
</div>
js实现
$('.file_upload').on('click', function () {
// 单个文件上传
// var fd = new FormData()
// var file = document.getElementById('file')
// fd.append('file', file.files[0])
axios({
method: 'post',
url: '/api/file_upload',
headers: {
'Content-Type': 'application/form-data'
},
// data:fd
data: new FormData($('#multipleForm')[0])
}).then(res => {
console.log(res.data)
const urls = res.data.url.split(';')
let imgHtml = '';
for(let i = 0; i < urls.length; i ++) {
imgHtml += `<img style="width: 200px" src="/${urls[i]}" />`
}
$('.file_upload-msg').html(`<div>success ${new Date()} 文件地址/${res.data.url} ${imgHtml}</div>`)
})
})
客户端会根据文件大小和用户要分片的大小来计算文件分片个数。客户端会一片一片的去请求接口把文件的所有片段上传带服务器端。
服务端接受客户端上传的文件片段进行缓存或创建文件并读入该片段,直至最后一片上传成功。
服务器端使用的是go语言的gin框架。
type ChunkFile struct {
Name string `json:"name" form:"name"`
Chunk int `json:"chunk" form:"chunk"`
Chunks int `json:"chunks" form:"chunks"`
}
func PathExists(path string) (bool, error) {
_, err := os.Stat(path)
if err == nil {
return true, nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
// 文件分片上传handler
func fileChunkUpload(c *gin.Context) {
var chunkFile ChunkFile
r := c.Request
c.Bind(&chunkFile)
var Buf = make([]byte, 0)
// in your case file would be fileupload
file, _, _ := r.FormFile("file")
log.Println("this is ", chunkFile.File)
Buf, _ = ioutil.ReadAll(file)
filePath := "upload/"+ chunkFile.Name
bool, _ := PathExists(filePath)
if !bool {
os.Create(filePath)
}
fd, _ := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
fd.Write(Buf)
fd.Close()
if chunkFile.Chunk + 1 == chunkFile.Chunks {
c.JSON(http.StatusOK, gin.H{
"state": "SUCCESS",
"url": "/"+filePath,
})
} else {
contentType := strings.Split(c.GetHeader("Content-Type"), "boundary=")
c.String(http.StatusOK, contentType[1])
}
}
客户端使用的是plupload文件上传插件,好处是它提供了分片上传,创建对象时配置chunk_size
属性就可以实现了(插件底层会根据文件大小和chunk_size
来计算分片的个数)。
var uploader = new plupload.Uploader({
runtimes : 'html5,flash,silverlight,html4',
browse_button : 'pickfiles', // you can pass an id...
container: document.getElementById('container'), // ... or DOM Element itself
url : '/api/file_chunk_upload',
flash_swf_url : '/static/js/Moxie.swf',
silverlight_xap_url : '/static/js/Moxie.xap',
chunk_size: '200kb',
filters : {
max_file_size : '10mb',
mime_types: [
{title : "Image files", extensions : "jpg,gif,png"},
{title : "Zip files", extensions : "zip"}
]
},
init: {
PostInit: function() {
document.getElementById('filelist').innerHTML = '';
document.getElementById('uploadfiles').onclick = function() {
uploader.start();
return false;
};
},
FilesAdded: function(up, files) {
plupload.each(files, function(file) {
document.getElementById('filelist').innerHTML += '<div id="' + file.id + '">' + file.name + ' (' + plupload.formatSize(file.size) + ') <b></b></div>';
});
},
UploadProgress: function(up, file) {
document.getElementById(file.id).getElementsByTagName('b')[0].innerHTML = '<span>' + file.percent + "%</span>";
},
Error: function(up, err) {
document.getElementById('console').appendChild(document.createTextNode("\nError #" + err.code + ": " + err.message));
}
}
});
uploader.bind('ChunkUploaded', function(up, file, info) {
// do some chunk related stuff
console.log(info)
});
uploader.init();