我们从来都不开发代码,我们只是代码的搬运工。
— 阿飞
希望大家都变卡卡西。 —啊贱
大家copy愉快,文档只做参考。如果发现问题或者有好的建议请回复我我回及时更正
Abstract
在学习web开发的过程中会遇到很多困难,因此写洗一篇类似综述类的文章。作为路线图从web开发要素的index出发来介绍golang开发的学习流程以及Example代码。在描述中多是使用代码来描述使用方法不会做过多的说明。最后可以方便的copy代码来实现自己的需求。
golang web 开发check list
本章节提供golang web开发的知识面参考。
- 基础知识全部略过,包含内容:
- 流程控制
- OOP
- 基础语法知识
- 路由器
- 手动路由
- 页面加载
- 纯静态页面(推荐,前后分离,工程好做。)
- 模板页面(gtpl模板,浪费cpu以及调试困难等因素这里就不介绍了。)
- 表示层脚本(JS)
- require.js
- jquery
- 业务层
- post
- 资源获取url
- 持久层
- 框架
- Mysql
- MongoDB
- 单元测试注意事项
路由器
路由器是整个网站对外的灵魂,如果路由做的不好URL会非常恶心。所以这部分设计成第一个要说的内容。
路由分两种一种是手动路由为了通过tul调度固定的功能,另外一点就是资源的获取,通过url的分析来模仿静态页的方式来获取资源(类似get)
自动路由,主要使用OOP的COMMAND模式来实现。所有功能使用post,
统一入口,方便权限管理,安全管理,跨域管理。但是如此强大的功能还是
交给框架来做吧。这里就不给新手做参考了。
手动路由
package main
import (
"log"
"net/http"
)
func main() {
RouterBinding() // 路由绑定函数
err := http.ListenAndServe( ":9090" , nil ) //设置监听的端口
if err != nil {
log.Fatal( "ListenAndServe: " , err)
}
}
在httpserver运行之前先绑定路由
手动路由的绑定
- 静态文件
http.Handle( "/pages/" , http.StripPrefix( "/pages/" , http.FileServer(http.Dir( "./pages" ))))
-
固定函数与资源获取
他们都是一样的
http.HandleFunc( "/images/" , fileUpload.DownloadPictureAction)
页面加载
-
纯静态页(HTML)
直接交给路由就行了。自动就访问那个文件夹了。不过生产环境果然还得是cdn,如果自己服务器比较多。可以nginx反向代理。主要好处前后分离,能上CDN就是通讯次数多了。不过通过优化改善之类的都还ok啦。
-
模板页面的加载
commonPage, err := template.ParseFiles( "pages/common/head.gtpl" , //加载模板
"pages/common/navbar.gtpl" , "pages/common/tail.gtpl" )
if err != nil {
panic (err.Error())
}
navArgs := map [ string ] string { "Home" : "home" , "User" : "yupengfei" } //复杂的参数开始往里塞
knowledgePage, err := template.ParseFiles( "pages/knowledge/knowledge.gtpl" )
knowledgeArgs := map [ string ] interface {}{ "Head" : "This is a test title" ,
"Author" : "kun.wang" , "PublishDatetime" : "2014-09-14" ,
"Content" : template.HTML( "<p style=/"text-indent: 2em/">为什么要用语义呢?</p>" )} //不是不好,只是做字符串分析会影响工程效率
commonPage.ExecuteTemplate(w, "header" , nil ) // render 开始
commonPage.ExecuteTemplate(w, "navbar" , navArgs)
knowledgePage.ExecuteTemplate(w, "knowledge" , knowledgeArgs)
commonPage.ExecuteTemplate(w, "tail" , nil )
仅提供关键代码。
- 其他的都还挺好,就是页面渲染用服务器是不是有点太奢侈了。
- 字符串数组作为输入参数差错比较困难
- 总结:虽然减少的通讯次数,但是没办法上CDN蛋疼,另外,模板的mapping蛋疼。
表示层脚本
表示层脚本做的比较困难也不是很好学。但是一旦搞定了,代码的复用性会有非常可观的提升。
就普通情况而言JS开发效率是非常高的灵活度高,并且使用的是客户端的cpu性能好,免费资源多,学习的人也多,好招聘。
require.js
- 加载
<script data-main= "/reqmod/login_main" language= "JavaScript" defer async= "true" src= "js/r.js" > </ script >
整个网页之留这么一个加载脚本的入口(每个页面最好只有一个js文件)
【好处】
- js是延迟加载。不会出现网页卡死的情况
-
最大化使用缓存。(HTTP 304)
【坏处】
-
学习比较难
-
网站更新始终有缓存没更新的浏览器。造成错误(所以有些情况客户自己就知道多刷新几次了,已经成用户习惯了)
【参数解释】
-
data-main
业务逻辑入口,载入当前字符串.js这个文件
-
language
不解释 -
defer async
字面意思 -
src
r.js就是require.js的意思。代码到处都能搞到。
- 页面Business
- 加载依赖文件
require .baseUrl = "/"
require .config({
baseUrl: require .baseUrl,
paths: {
"jquery" : "js/jquery-1.10.2.min" ,
"domready" : "reqmod/domReady" ,
"pm" : "reqmod/pmodal" ,
"cookie" : "reqmod/cookie" ,
"user" : "reqmod/user" ,
"bootstrap" : "reqmod/bootstrap.min" ,
"nav" : "reqmod/nav"
},
shim: {
'bootstrap' : {
deps: [ 'jquery' ]
}
}
});
直接copy全搞定。
- 执行页面business
执行里面做的最多的就是dom跟事件绑定而已。加载各种js库直接引用。代码美观,开发效率,执行效率都是非常棒的。
require ([ 'nav' , 'domready' , 'jquery' , 'user' , 'pm' ], function (nav,doc, $, user,pm) {
//binding event is ok!
doc( function () {
pm.load(); //加载各种插件HTML模板之类的都ok
$( '#btn_login' )[ 0 ].onclick = function () {user.login();} //button 事件绑定
});
});
1. `require` 这个函数里面第一个参数是上面声明的里面的key 1. `function` 中的参数跟左边的对应,如果没有操作符,或者知识依赖于`$`(JQuery) 那么只在第一个参数中声明就ok了。**注意顺序是对应的** 1. `doc` dom ready API 是等待dom加载完成之后执行的函数 【总结】 1. 有了这个库之后页面只需要一个js文件,再也不乱了。 1. 有了这个库之后页面事件绑定只需要id(或者说DOM能找到就ok)
- 页面MODEL
define([ 'jquery' , 'reqmod/cookie' , 'user' , 'bootstrap' ], function ($,cookie,user) {
var nav_load = function () {
$.get( '/nav.html' , function (result) {
var newNode = document .createElement( "div" );
newNode.innerHTML = result;
$( 'body' )[ 0 ].insertBefore(newNode,$( 'body' )[ 0 ].firstChild);
//document.body.innerHTML = result + document.body.innerHTML;
$( '#btn_login' )[ 0 ].onclick = function () {user.login();}
$( '#btn_reg' )[ 0 ].onclick = function () { window .location= '/register.html' }
$.post( '/login_check' ,{}, function (data) {
if (data== 0 ){
Form_login.style.display= ""
}
else {
form_userInfo.style.display= ""
}
})
});
}
return {
load :nav_load
};
});
这个人require很像,但是函数叫`define` 参数全是一样的 但是 【注意】 > 这里引用的路径(单引号里面的依赖)一定要跟页面主business文件中有path配置,不然就要写网站绝对路径。T.T吃了不止一次亏。 【函数的定义】
var nav_load = function () {}
只接受var匿名函数定义。 【最后的return】 注意其实就是个微型路由。假定你又很多调试方案,来回测试的时候使用不同的业务直接修改路由就行了。很方便。
JQuery
JQ的功能只要require.js引用了之后基本上都是一样的。如果有需要可以到w3school上学习一下。
业务层
- Post分析
func XXXAction(w http.ResponseWriter, r *http.Request) {
r.parseForm() //有这个才能获取参数
r.Form[ "Email" ] // 获取Email 参数(String)
}
然后做业务就行了。
- 资源入口函数资源require分析(url分析固定写法)
func Foo(w http.ResponseWriter, r *http.Request) {
queryFile := strings.Split(r.URL.Path, "/" )
queryResource := queryFile[ len (queryFile )-1 ] // 解析文件
}
完成字符串分割之后,按照需求来获取资源就可以了。
持久层
框架
没映射不开心,
1. 我得兼容所有的系统,所以要设定专门的object做数据库的CRUD 2. OBJ GET SET ok~
Mysql
在观察代码的时候有个方便的方法就是去掉异常处理的部分 if err XXXXX那些都去掉。就好看多了
怎么说呢golang的err处理来回嵌套一次一次的,卧槽,让你迷糊都。之后会在utility里面直接处理,会方便很多。
其实不管什么语言的Mysql驱动都是从PRO*C来的,所以会PRO*/C之后,啥都好说了就
1. Insert Delete Update
stmt, err := mysqlUtility.DBConn.Prepare( "INSERT INTO credit (credit_code, user_code, credit_rank) VALUES (?, ?, ?)" )
if err != nil {
pillarsLog.PillarsLogger.Print(err.Error())
return false , err
}
defer stmt.Close()
_, err = stmt.Exec(credit.CreditCode, credit.UserCode, credit.CreditRank)
if err != nil {
return false , err
} else {
return true , err
}
这个SQL fetch做的还是算比较人道的。 1. Query
stmt, err := mysqlUtility.DBConn.Prepare( `SELECT commodity_code, commodity_name, description, picture,
price, storage, count, status,
insert_datetime, update_datetime FROM commodity WHERE commodity_code = ?`)
if err != nil {
return nil , err
}
defer stmt.Close()
result, err := stmt.Query(commodityCode)
if err != nil {
return nil , err
}
defer result.Close()
var commodity utility.Commodity
if result.Next() {
err = result.Scan(&(commodity.CommodityCode), &(commodity.CommodityName), &(commodity.Description),
&(commodity.Picture), &(commodity.Price), &(commodity.Storage), &(commodity.Count), &(commodity.Status),
&(commodity.InsertDatetime), &(commodity.UpdateDatetime))
if err != nil {
pillarsLog.PillarsLogger.Print(err.Error())
return nil , err
}
}
return &commodity, err
Mongodb
err := mongoUtility.PictureCollection.Find(bson.M{ "picturecode" :*pictureCode}).One(&picture)
这里只给出最简单的例子。具体的看mgo的开发文档就ok
单元测试注意事项
- 测试命令 go test -v (没有其他参数了!!!)
如果不带-v只显示结果,不显示调试过程,主要是调试开发的时候用
- 文件格式 xxx_test.go 但是建议改成 xxx_test0.go 或者喜欢改成别的也可以。
- 由于测试先行的原则,在开发的时候一次测试也就一两个函数。
- 这样相当于把其他测试注释掉
- 测试的时候的配置文件要放到测试目录下面。别忘了。
- 心态,错误太多一个一个来,要有个好心态。
LOG
-
注意在调试中Log的不可缺失性。
下面api如果不知道从何而来直接doc搜索就可以了。
package utility
import "log"
import "os"
import "fmt"
// Logger Model min variable.
var Logger *log.Logger
var outFile *os.File
// init function if Logger if not inited will invoke this function
func init() {
if Logger == nil {
propertyMap := ReadProperty( "pic.properties" )
logFileName := propertyMap[ "LogFile" ]
fmt.Println( "Initial and Open log file " , logFileName)
var err error
outFile, err = os.OpenFile(logFileName, os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666 )
if err != nil {
panic (err.Error())
}
Logger = log.New(outFile, "" , log.Ldate|log.Ltime|log.Llongfile)
}
}
// CloseLogFile function : close Logger invoke file.
func CloseLogFile() {
outFile.Close()
}
使用方法:
utility.Logger.Println( "Log test" )