详解Golang Iris框架的基本使用

2024-10-06 16:03:54

Iris介绍

编写一次并在任何地方以最小的机器功率运行，如Android、ios、Linux和Windows等。它支持Google Go，只需一个可执行的服务即可在所有平台。 Iris以简单而强大的api而闻名。除了Iris为您提供的低级访问权限。 Iris同样擅长MVC。它是唯一一个拥有MVC架构模式丰富支持的Go Web框架，性能成本接近于零。 Iris为您提供构建面向服务的应用程序的结构。用Iris构建微服务很容易。

1. Iris框架

1.1 Golang框架

Golang常用框架有：Gin、Iris、Beego、Buffalo、Echo、Revel，其中Gin、Beego和Iris较为流行。Iris是目前流行Golang框架中唯一提供MVC支持（实际上Iris使用MVC性能会略有下降）的框架，并且支持依赖注入，使用入门简单，能够快速构建Web后端，也是目前几个框架中发展最快的，从2016年截止至目前总共有17.4k stars（Gin 35K stars）。

Iris is a fast, simple yet fully featured and very efficient web framework for Go. It provides a beautifully expressive and easy to use foundation for your next website or API.

1.2 安装Iris

Iris官网：https://iris-go.com/
Iris Github：https://github.com/kataras/iris

# go get -u -v 获取包
go get github.com/kataras/iris/v12@latest
# 可能提示@latest是错误，如果版本大于11，可以使用下面打开GO111MODULE选项
# 使用完最好关闭，否则编译可能出错
go env -w GO111MODULE=on
# go get失败可以更改代理
go env -w GOPROXY=https://goproxy.cn,direct

2. 使用Iris构建服务端

2.1 简单例子1——直接返回消息

package main

import (
	"github.com/kataras/iris/v12"
	"github.com/kataras/iris/v12/middleware/logger"
	"github.com/kataras/iris/v12/middleware/recover"
)

func main() {
	app := iris.New()
	app.Logger().SetLevel("debug")
	// 设置recover从panics恢复，设置log记录
	app.Use(recover.New())
	app.Use(logger.New())

	app.Handle("GET", "/", func(ctx iris.Context) {
		ctx.HTML("<h1>Hello Iris!</h1>")

	})
	app.Handle("GET", "/getjson", func(ctx iris.Context) {
		ctx.JSON(iris.Map{"message": "your msg"})
	})

	app.Run(iris.Addr("localhost:8080"))
}

其他便捷设置方法：

// 默认设置日志和panic处理
app := iris.Default()

我们可以看到iris.Default()的源码：

// 注：默认设置"./view"为html view engine目录
func Default() *Application {
	app := New()
	app.Use(recover.New())
	app.Use(requestLogger.New())
	app.defaultMode = true
	return app
}

2.2 简单例子2——使用HTML模板

package main

import "github.com/kataras/iris/v12"

func main() {
	app := iris.New()
	// 注册模板在work目录的views文件夹
	app.RegisterView(iris.HTML("./views", ".html"))

	app.Get("/", func(ctx iris.Context) {
		// 设置模板中"message"的参数值
		ctx.ViewData("message", "Hello world!")
		// 加载模板
		ctx.View("hello.html")
	})

	app.Run(iris.Addr("localhost:8080"))
}

上述例子使用的hello.html模板

<html>
<head>
	<title>Hello Page</title>
</head>
<body>
	<h1>{{ .message }}</h1>
</body>
</html>

2.3 路由处理

上述例子中路由处理，可以使用下面简单替换，分别针对HTTP中的各种方法

app.Get("/someGet", getting)
app.Post("/somePost", posting)
app.Put("/somePut", putting)
app.Delete("/someDelete", deleting)
app.Patch("/somePatch", patching)
app.Head("/someHead", head)
app.Options("/someOptions", options)

例如，使用路由“/hello”的Get路径

app.Get("/hello", handlerHello)

func handlerHello(ctx iris.Context) {
	ctx.WriteString("Hello")
}

// 等价于下面
app.Get("/hello", func(ctx iris.Context) {
		ctx.WriteString("Hello")
	})

2.4 使用中间件

app.Use(myMiddleware)

func myMiddleware(ctx iris.Context) {
	ctx.Application().Logger().Infof("Runs before %s", ctx.Path())
	ctx.Next()
}

2.5 使用文件记录日志

整个Application使用文件记录

上述记录日志

// 获取当前时间
now := time.Now().Format("20060102") + ".log"
// 打开文件，如果不存在创建，如果存在追加文件尾，权限为：拥有者可读可写
file, err := os.OpenFile(now, os.O_CREATE | os.O_APPEND, 0600)
defer file.Close()
if err != nil {
	app.Logger().Errorf("Log file not found")
}
// 设置日志输出为文件
app.Logger().SetOutput(file)

到文件可以和中间件结合，以控制不必要的调试信息记录到文件

func myMiddleware(ctx iris.Context) {
	now := time.Now().Format("20060102") + ".log"
	file, err := os.OpenFile(now, os.O_CREATE | os.O_APPEND, 0600)
	defer file.Close()
	if err != nil {
		ctx.Application().Logger().SetOutput(file).Errorf("Log file not found")
		os.Exit(-1)
	}
	ctx.Application().Logger().SetOutput(file).Infof("Runs before %s", ctx.Path())
	ctx.Next()
}

上述方法只能打印Statuscode为200的路由请求，如果想要打印其他状态码请求，需要另使用

app.OnErrorCode(iris.StatusNotFound, func(ctx iris.Context) {
	now := time.Now().Format("20060102") + ".log"
	file, err := os.OpenFile(now, os.O_CREATE | os.O_APPEND, 0600)
	defer file.Close()
	if err != nil {
		ctx.Application().Logger().SetOutput(file).Errorf("Log file not found")
		os.Exit(-1)
	}
	ctx.Application().Logger().SetOutput(file).Infof("404")
	ctx.WriteString("404 not found")
})

Iris有十分强大的路由处理程序，你能够按照十分灵活的语法设置路由路径，并且如果没有涉及正则表达式，Iris会计算其需求预先编译索引，用十分小的性能消耗来完成路由处理。

注：ctx.Params()和ctx.Values()是不同的，下面是官网给出的解释：

Path parameter's values can be retrieved from ctx.Params()Context's local storage that can be used to communicate between handlers and middleware(s) can be stored to ctx.Values() .

Iris可以使用的参数类型

Param Type	Go Type	Validation	Retrieve Helper
:string	string	anything (single path segment)	Params().Get
:int	int	-9223372036854775808 to 9223372036854775807 (x64) or -2147483648 to 2147483647 (x32), depends on the host arch	Params().GetInt
:int8	int8	-128 to 127	Params().GetInt8
:int16	int16	-32768 to 32767	Params().GetInt16
:int32	int32	-2147483648 to 2147483647	Params().GetInt32
:int64	int64	-9223372036854775808 to 92233720368?4775807	Params().GetInt64
:uint	uint	0 to 18446744073709551615 (x64) or 0 to 4294967295 (x32), depends on the host arch	Params().GetUint
:uint8	uint8	0 to 255	Params().GetUint8
:uint16	uint16	0 to 65535	Params().GetUint16
:uint32	uint32	0 to 4294967295	Params().GetUint32
:uint64	uint64	0 to 18446744073709551615	Params().GetUint64
:bool	bool	“1” or “t” or “T” or “TRUE” or “true” or “True” or “0” or “f” or “F” or “FALSE” or “false” or “False”	Params().GetBool
:alphabetical	string	lowercase or uppercase letters	Params().Get
:file	string	lowercase or uppercase letters, numbers, underscore (_), dash (-), point (.) and no spaces or other special characters that are not valid for filenames	Params().Get
:path	string	anything, can be separated by slashes (path segments) but should be the last part of the route path	Params().Get

在路径中使用参数

app.Get("/users/{id:uint64}", func(ctx iris.Context){
	id := ctx.Params().GetUint64Default("id", 0)
})

使用post传递参数

app.Post("/login", func(ctx iris.Context) {
		username := ctx.FormValue("username")
		password := ctx.FormValue("password")
		ctx.JSON(iris.Map{
			"Username": username,
			"Password": password,
		})
	})

以上就是Iris的基本入门使用，当然还有更多其他操作：中间件使用、正则表达式路由路径的使用、Cache、Cookie、Session、File Server、依赖注入、MVC等的用法，可以参照官方教程使用，后期有时间会写文章总结。

到此这篇关于详解Golang Iris框架的基本使用的文章就介绍到这了,更多相关Golang Iris框架使用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

mac下安装golang框架iris的方法

安装前准备: 设置GOPROXY代理参考:https://goproxy.cn/ 我使用的是下面的两条命令: $ go env -w GO111MODULE=on $ go env -w GOPROXY=https://goproxy.cn,direct 我的go env信息: % go env GO111MODULE="on" GOARCH="amd64" GOBIN="" GOCACHE="/Users/mac/Library/C
golang常用库之操作数据库的orm框架-gorm基本使用详解

golang常用库:gorilla/mux-http路由库使用 golang常用库:配置文件解析库-viper使用 golang常用库:操作数据库的orm框架-gorm基本使用一:字段映射-模型定义 gorm中通常用struct来映射字段. gorm教程中叫模型定义比如我们定义一个模型Model: type User struct { gorm.Model UserId int64 `gorm:"index"` //设置一个普通的索引,没有设置索引名,gorm会自动命名 Birth
golang 网络框架之gin的使用方法

golang 原生 http 库已经可以很方便地实现一个 http server 了,但对于复杂的 web 服务来说,路由解析,请求参数解析,对象返回等等,原生 api 就显得有些不太够用了,而 gin 是一个功能完备,性能很高的 web 网络框架,特别适合 web api 的开发 hello world package main import "github.com/gin-gonic/gin" func main() { r := gin.New() r.GET("/pi
golang日志框架之logrus的使用

golang日志库 golang标准库的日志框架非常简单,仅仅提供了print,panic和fatal三个函数对于更精细的日志级别.日志文件分割以及日志分发等方面并没有提供支持.所以催生了很多第三方的日志库,但是在golang的世界里,没有一个日志库像slf4j那样在Java中具有绝对统治地位.golang中,流行的日志框架包括logrus.zap.zerolog.seelog等. logrus是目前Github上star数量最多的日志库,目前(2018.08,下同)star数量为8119,fo
详解Golang Iris框架的基本使用

Iris介绍编写一次并在任何地方以最小的机器功率运行,如Android.ios.Linux和Windows等.它支持Google Go,只需一个可执行的服务即可在所有平台. Iris以简单而强大的api而闻名. 除了Iris为您提供的低级访问权限. Iris同样擅长MVC. 它是唯一一个拥有MVC架构模式丰富支持的Go Web框架,性能成本接近于零. Iris为您提供构建面向服务的应用程序的结构. 用Iris构建微服务很容易. 1. Iris框架 1.1 Golang框架 Golang常用
详解Golang语言HTTP客户端实践

目录 HTTP客户端封装测试脚本测试服务最近在学习Golang语言,中间遇到一个前辈指点,有一个学习原则:Learning By Doing.跟我之前学习Java的经验高度契合.在前一段时间学习洼坑中挣扎了好几天,差点就忘记这个重要的成功经验. 那么那什么来做练习呢?当然结合当下的工作啦,所以我列了一个路线给自己,那就是从接口测试开始学起来,从功能测试到性能测试,然后掌握基本Server开发技能. 首先,得先把HTTP接口测试常用的几个功能实现了,主要是获取HTTPrequest对象,发送
Go依赖注入DI工具wire使用详解(golang常用库包)

目录什么是依赖注入第一次编写mysql操作类: 第二次编写mysql操作类: 第三次编写mysql操作类: 何时使用依赖注入 wire 概念说明 provider 和 injector provider injector wire 使用快速开始小结绑定接口 Provider Set 参考 google 出品的依赖注入库 wire:https://github.com/google/wire 什么是依赖注入依赖注入 ,英文全名是 dependency injection,简写为 DI.
详解Golang中Context的原理和使用技巧

目录 Context 背景和适用场景 Context 的背景 Context 的功能和目的 Context 的基本使用 Context 的同步控制设计 Context 的定义和实现 Context interface 接口定义 parent Context 的具体实现 Context 的继承和各种 With 系列函数 Context 的常用方法实例 1. 调用 Context Done方法取消 2. 通过 context.WithValue 来传值 3. 超时取消 context.WithT
一文详解Golang的中间件设计模式

目录背景 Demo 验证结论背景记录一下自己在go开发和学习上的一些笔记最近在看一些rpc框架的使用原理和源码的时候,对中间件的实现非常感兴趣,然后也看了一下grpc的中间件的用法,也看了别的框架的中间件的设计,感觉grpc的还算是比较容易弄懂,于是记录一下这个常用中间件的实现的一个原理的demo(吐槽一下其他的rpc框架分为inbound和outbound的middleware感觉好像有点复杂化了,所以我也不知道哪种设计会比较好,楼主是java出身,所以对反射走aop的那种模式比较熟悉
详解Golang 与python中的字符串反转

详解Golang 与python中的字符串反转在go中,需要用rune来处理,因为涉及到中文或者一些字符ASCII编码大于255的. func main() { fmt.Println(reverse("Golang python")) } func reverse(src string) string { dst := []rune(src) len := len(dst) var result []rune result = make([]rune, 0) for i := le
详解Golang 中的并发限制与超时控制

前言上回在用 Go 写一个轻量级的 ssh 批量操作工具里提及过,我们做 Golang 并发的时候要对并发进行限制,对 goroutine 的执行要有超时控制.那会没有细说,这里展开讨论一下. 以下示例代码全部可以直接在 The Go Playground上运行测试: 并发我们先来跑一个简单的并发看看 package main import ( "fmt" "time" ) func run(task_id, sleeptime int, ch chan st
详解在YII2框架中使用UEditor编辑器发布文章

本文介绍了详解在YII2框架中使用UEditor编辑器发布文章 ,分享给大家,具体如下: 创建文章数据表文章数据表主要有4个字段 1.id 主键(int) 2.title 标题(varchar) 3.content 内容(text) 4.created_time 创建时间(int) 创建文章模型创建文章模型,不要忘记设置验证规则和字段的名称 namespace backend\models; class Article extends \yii\db\ActiveRecord { publ
详解Golang开启http服务的三种方式

前言都说go标准库实用,Api设计简洁.这次就用go 标准库中的net/http包实现一个简洁的http web服务器,包括三种版本. v1最简单版直接使用http.HandleFunc(partern,function(http.ResponseWriter,*http.Request){}) HandleFunc接受两个参数,第一个为路由地址,第二个为处理方法. //v1 func main() { http.HandleFunc("/", func(w http.Respon
详解Golang中的各种时间操作

需求时间格式的转换比较麻烦,自己写了个工具,可以通过工具中的这些方法相互调用转成自己想要的格式,代码如下,后续有新的函数再添加实现代码 package utils import "time" const ( TIMEFORMAT = "20060102150405" NORMALTIMEFORMAT = "2006-01-02 15:04:05" ) // 当前时间 func GetTime() time.Time{ return time.