doc

package module

v1.1.1-alpha23 Latest Latest Go to latest Published: Dec 27, 2021 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/snowlyg/iris-admin

README ¶

IrisAdmin

简体中文 | English

项目地址

GITHUB | GITEE

简单项目仅供学习，欢迎指点！

交流方式

iris-go-tenancy/community .

iris 学习记录分享

项目介绍

项目由多个服务构成,每个服务有不同的功能.

[viper_server]
- 服务配置初始化,并生成本地配置文件
- 使用 github.com/spf13/viper 第三方包实现
- 需要实现 func getViperConfig() viper_server.ViperConfig 方法

package cache

import (
	"fmt"

	"github.com/fsnotify/fsnotify"
	"github.com/snowlyg/iris-admin/g"
	"github.com/snowlyg/iris-admin/server/viper_server"
	"github.com/spf13/viper"
)

var CONFIG Redis

type Redis struct {
	DB       int    `mapstructure:"db" json:"db" yaml:"db"`
	Addr     string `mapstructure:"addr" json:"addr" yaml:"addr"`
	Password string `mapstructure:"password" json:"password" yaml:"password"`
	PoolSize int    `mapstructure:"pool-size" json:"poolSize" yaml:"pool-size"`
}

// getViperConfig 获取初始化配置
func getViperConfig() viper_server.ViperConfig {
	configName := "redis"
	db := fmt.Sprintf("%d", CONFIG.DB)
	poolSize := fmt.Sprintf("%d", CONFIG.PoolSize)
	return viper_server.ViperConfig{
		Directory: g.ConfigDir,
		Name:      configName,
		Type:      g.ConfigType,
		Watch: func(vi *viper.Viper) error {
			if err := vi.Unmarshal(&CONFIG); err != nil {
				return fmt.Errorf("反序列化错误: %v", err)
			}
			// 监控配置文件变化
			vi.SetConfigName(configName)
			vi.WatchConfig()
			vi.OnConfigChange(func(e fsnotify.Event) {
				fmt.Println("配置发生变化:", e.Name)
				if err := vi.Unmarshal(&CONFIG); err != nil {
					fmt.Printf("反序列化错误: %v \n", err)
				}
			})
			return nil
		},
		// 注意:设置默认配置值的时候,前面不能有空格等其他符号.必须紧贴左侧.
		Default: []byte(`
db: ` + db + `
addr: "` + CONFIG.Addr + `"
password: "` + CONFIG.Password + `"
pool-size: ` + poolSize),
	}
}

[zap_server]
- 服务日志记录
- 使用 go.uber.org/zap 第三方包实现
- 通过全局变量 zap_server.ZAPLOG 记录对应级别的日志

  zap_server.ZAPLOG.Info("注册数据表错误", zap.Any("err", err))
  zap_server.ZAPLOG.Debug("注册数据表错误", zap.Any("err", err))
  zap_server.ZAPLOG.Error("注册数据表错误", zap.Any("err", err))
  ...

[database]
- 数据服务 [目前仅支持 mysql]
- 使用 gorm.io/gorm 第三方包实现
- 通过单列 database.Instance() 操作数据

  database.Instance().Model(&User{}).Where("name = ?","name").Find(&user)
  ...

[casbin]
- 权限控制管理服务
- 使用 casbin 第三方包实现
- 并通过 index.Use(casbin.Casbin()) 使用中间件,实现接口权限认证
[cache]
- 缓存驱动服务
- 使用 github.com/go-redis/redis 第三方包实现
- 通过单列 cache.Instance() 操作数据
[operation]
- 系统操作日志服务
- 并通过 index.Use(operation.OperationRecord()) 使用中间件,实现接口自动生成操作日志
[web]
- web_iris Go-Iris 框架服务
- 使用 github.com/kataras/iris/v12 第三方包实现
- web 框架服务需要实现 type WebFunc interface {} 接口

// WebFunc 框架服务接口
// - GetTestClient 测试客户端
// - GetTestLogin 测试登录
// - AddWebStatic 添加静态页面
// - AddUploadStatic 上传文件路径
// - Run 启动
type WebFunc interface {
	GetTestClient(t *testing.T) *httptest.Client
	GetTestLogin(t *testing.T, url string, res httptest.Responses, datas ...interface{}) *httptest.Client
	AddWebStatic(perfix string)
	AddUploadStatic()
	InitRouter() error
	Run()
}

数据初始化

简单初始化.

使用原生方法 AutoMigrate() 自动迁移初始化数据表

package main

import (
	"github.com/snowlyg/iris-admin/server/web"
	"github.com/snowlyg/iris-admin/server/web/web_iris"
  "github.com/snowlyg/iris-admin-rbac/iris/perm"
	"github.com/snowlyg/iris-admin-rbac/iris/role"
	"github.com/snowlyg/iris-admin/server/database"
	"github.com/snowlyg/iris-admin/server/operation"
)

func main() {
  	database.Instance().AutoMigrate(&perm.Permission{},&role.Role{},&user.User{},&operation.Oplog{})
}

自定义迁移工具初始化.

使用 gormigrate 第三方依赖包实现数据的迁移控制，方便后续的升级和开发
使用方法详情见 iris-admin-cmd

简单使用

获取依赖包,注意必须带上 master 版本

 go get github.com/snowlyg/iris-admin@master

添加 main.go 文件

package main

import (
	"github.com/snowlyg/iris-admin/server/web"
	"github.com/snowlyg/iris-admin/server/web/web_iris"
)

func main() {
  wi := web_iris.Init()
	web.Start(wi)
}

启动项目

第一次启动项目后,配置文件会自动生成到 config 目录下.
同时会生成一个 rbac_model.conf 文件到项目根目录,该文件用于 casbin 权鉴的规则.

go run main.go

添加模块

如果需要权鉴管理，可以使用 iris-admin-rbac 项目快速集成权鉴功能
可以使用 AddModule() 增加其他 admin模块

package main

import (
	rbac "github.com/snowlyg/iris-admin-rbac/iris"
	"github.com/snowlyg/iris-admin/server/web"
	"github.com/snowlyg/iris-admin/server/web/web_iris"
)

func main() {
	wi := web_iris.Init()
	rbacParty := web_iris.Party{
		Perfix:    "/api/v1",
		PartyFunc: rbac.Party(),
	}
	wi.AddModule(rbacParty)
	web.Start(web_iris.Init())
}

设置静态文件路径

已经默认内置了一个静态文件访问路径
静态文件将会上传到 /static/upload 目录
可以修改配置项 static-path 修改默认目录

system:
  addr: "127.0.0.1:8085"
  db-type: ""
  level: debug
  static-abs-path: /static/upload
  static-prefix: /upload
  time-format: "2006-01-02 15:04:05"
  web-prefix: /admin
  web-path: ./dist

设置其他静态文件路径

设置其他静态文件路径，可以使用 AddStatic 方法

package main

import (
	"github.com/kataras/iris/v12"
	"github.com/snowlyg/iris-admin/server/web"
)

func main() {
	webServer := web_iris.Init()
    fsOrDir := iris.Dir(filepath.Join(dir.GetCurrentAbPath(), "/other"))
	webServer.AddStatic("/other",fsOrDir)
	webServer.Run()
}

配合前端使用

编译前端页面默认 dist 目录
可以修改配置项 web-path 修改默认目录

package main

import (
	"github.com/kataras/iris/v12"
	"github.com/snowlyg/iris-admin/server/web"
)

func main() {
	webServer := web_iris.Init()
	webServer.AddWebStatic("/")
	webServer.Run()
}

前端页面参考/借用：【前端只简单实现预览效果】
gin-vue-admin
vue-element-admin

简单用例

iris
gin

RBAC

iris-admin-rbac

单元测试和接口文档

测试前,需要设置 mysqlPwd 和 redisPwd 两个系统环境变量，运行测试实例的时候将会使用到它们。
测试使用依赖库 helper/tests 是基于 httpexpect/v2 的简单封装
接口单元测试例子
接口单元测试例子

感谢

JetBrains 对本项目的支持。

Documentation ¶

Overview ¶

<h1 align="center">IrisAdmin</h1>

<a href="https://codecov.io/gh/snowlyg/iris-admin"><img src="https://codecov.io/gh/snowlyg/iris-admin/branch/master/graph/badge.svg" alt="Code Coverage"></a>
<a href="https://goreportcard.com/badge/github.com/snowlyg/iris-admin"><img src="https://goreportcard.com/badge/github.com/snowlyg/iris-admin" alt="Go Report Card"></a>
<a href="https://godoc.org/github.com/snowlyg/iris-admin"><img src="https://godoc.org/github.com/snowlyg/iris-admin?status.svg" alt="GoDoc"></a>
<a href="https://github.com/snowlyg/iris-admin/blob/master/LICENSE"><img src="https://img.shields.io/github/license/snowlyg/iris-admin" alt="Licenses"></a>

</div>

[简体中文](./README.md) | English

#### Project url [GITHUB](https://github.com/snowlyg/iris-admin) | [GITEE](https://gitee.com/snowlyg/iris-admin) **** > This project just for learning golang, welcome to give your suggestions!

#### Documentation - [IRIS V12 document for chinese](https://github.com/snowlyg/iris/wiki) - [godoc](https://pkg.go.dev/github.com/snowlyg/iris-admin?utm_source=godoc)

#### COMMUNICATIONS - iris-go-tenancy/community(https://gitter.im/iris-go-tenancy/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link) [![Gitter](https://badges.gitter.im/iris-go-tenancy/community.svg)](https://gitter.im/iris-go-tenancy/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) .

#### BLOG

- [REST API with iris-go web framework ](https://blog.snowlyg.com/iris-go-api-1/)

- [How to user iris-go with casbin](https://blog.snowlyg.com/iris-go-api-2/)

---

#### Program introduction

##### The project consists of multiple services, each with different functions.

- [viper_server] - - The service configuration is initialized and generate a local configuration file. - - Use github.com/spf13/viper(https://github.com/spf13/viper) third party package. - - Need implement `func getViperConfig() viper_server.ViperConfig` function.

```go package cache

import (

"fmt"

"github.com/fsnotify/fsnotify"
"github.com/snowlyg/iris-admin/g"
"github.com/snowlyg/iris-admin/server/viper_server"
"github.com/spf13/viper"

)

var CONFIG Redis

type Redis struct {
	DB       int    `mapstructure:"db" json:"db" yaml:"db"`
	Addr     string `mapstructure:"addr" json:"addr" yaml:"addr"`
	Password string `mapstructure:"password" json:"password" yaml:"password"`
	PoolSize int    `mapstructure:"pool-size" json:"poolSize" yaml:"pool-size"`
}

// getViperConfig get initialize config

func getViperConfig() viper_server.ViperConfig {
	configName := "redis"
	db := fmt.Sprintf("%d", CONFIG.DB)
	poolSize := fmt.Sprintf("%d", CONFIG.PoolSize)
	return viper_server.ViperConfig{
		Directory: g.ConfigDir,
		Name:      configName,
		Type:      g.ConfigType,
		Watch: func(vi *viper.Viper) error {
			if err := vi.Unmarshal(&CONFIG); err != nil {
				return fmt.Errorf("deserialization data error: %v", err)
			}
			// config file change
			vi.SetConfigName(configName)
			vi.WatchConfig()
			vi.OnConfigChange(func(e fsnotify.Event) {
				fmt.Println("config file change:", e.Name)
				if err := vi.Unmarshal(&CONFIG); err != nil {
					fmt.Printf("deserialization data error: %v \n", err)
				}
			})
			return nil
		},
		// Note: When setting the default configuration value, there can be no other symbols such as spaces in front. It must be close to the left
		Default: []byte(`

db: ` + db + ` addr: "` + CONFIG.Addr + `" password: "` + CONFIG.Password + `" pool-size: ` + poolSize),

}
}

```

- [zap_server] - - Service logging. - - Use go.uber.org/zap(https://pkg.go.dev/go.uber.org/zap) third party package. - - Through global variables `zap_server.ZAPLOG` record the log of the corresponding level. ```go

zap_server.ZAPLOG.Info("Registration data table error", zap.Any("err", err))
zap_server.ZAPLOG.Debug("Registration data table error", zap.Any("err", err))
zap_server.ZAPLOG.Error("Registration data table error", zap.Any("err", err))
...

```

- [database] - - database service [only support mysql now]. - - Use gorm.io/gorm(https://github.com/go-gorm/gorm) third party package. - - Through single instance `database.Instance()` operating data. ```go

database.Instance().Model(&User{}).Where("name = ?","name").Find(&user)
...

```

- [casbin] - - Access control management service. - - Use [casbin](github.com/casbin/casbin/v2 ) third party package. - - Through use `index.Use(casbin.Casbin())` middleware on route,implement interface authority authentication

- [cache] - - Cache-driven service - - Use github.com/go-redis/redis(https://github.com/go-redis/redis) third party package. - - Through single instance `cache.Instance()` operating data.

- [operation] - - System operation log service. - - Through use `index.Use(operation.OperationRecord())` middleware on route , realize the interface to automatically generate operation logs.

- [web] - - web_iris Go-Iris web framework service. - - Use github.com/kataras/iris/v12(https://github.com/kataras/iris) third party package. - - web framework service need implement `type WebFunc interface {}` interface. ```go // WebFunc web framework service interface // - GetTestClient test client // - GetTestLogin login for test // - AddWebStatic add web static file // - AddUploadStatic add upload file api // - Run start program

type WebFunc interface {
	GetTestClient(t *testing.T) *httptest.Client
	GetTestLogin(t *testing.T, url string, res httptest.Responses, datas ...interface{}) *httptest.Client
	AddWebStatic(perfix string)
	AddUploadStatic()
	InitRouter() error
	Run()
}

``` #### Initialize database

##### Simple - Use gorm's `AutoMigrate()` function to auto migrate database. ```go package main

import (

	"github.com/snowlyg/iris-admin/server/web"
	"github.com/snowlyg/iris-admin/server/web/web_iris"
  "github.com/snowlyg/iris-admin-rbac/iris/perm"
	"github.com/snowlyg/iris-admin-rbac/iris/role"
	"github.com/snowlyg/iris-admin/server/database"
	"github.com/snowlyg/iris-admin/server/operation"

)

func main() {
  	database.Instance().AutoMigrate(&perm.Permission{},&role.Role{},&user.User{},&operation.Oplog{})
}

```

##### Custom migrate tools - Use `gormigrate` third party package. Tt's helpful for database migrate and program development. - Detail is see [iris-admin-cmd](https://github.com/snowlyg/iris-admin-example/blob/main/iris/cmd/main.go.

---

#### Getting started - Get master package , Notice must use `master` version. ```sh

go get github.com/snowlyg/iris-admin@master

``` - Add main.go file. ```go package main

import (

"github.com/snowlyg/iris-admin/server/web"
"github.com/snowlyg/iris-admin/server/web/web_iris"

)

func main() {
  wi := web_iris.Init()
	web.Start(wi)
}

```

#### Run project - When you first run this cmd `go run main.go` , you can see some config files in the `config` directory, - and `rbac_model.conf` will be created in your project root directory. ```sh go run main.go ```

#### Module - You can use [iris-admin-rbac](https://github.com/snowlyg/iris-admin-rbac) package to add rbac function for your project quickly. - Your can use AddModule() to add other modules . ```go package main

import (

rbac "github.com/snowlyg/iris-admin-rbac/iris"
"github.com/snowlyg/iris-admin/server/web"
"github.com/snowlyg/iris-admin/server/web/web_iris"

)

func main() {
	wi := web_iris.Init()
	rbacParty := web_iris.Party{
		Perfix:    "/api/v1",
		PartyFunc: rbac.Party(),
	}
	wi.AddModule(rbacParty)
	web.Start(web_iris.Init())
}

```

#### Default static file path - A static file access path has been built in by default - Static files will upload to `/static/upload` directory. - You can set this config key `static-path` to change the default directory. ```yaml system:

addr: "127.0.0.1:8085"
db-type: ""
level: debug
static-path: /static/upload
static-prefix: /upload
time-format: "2006-01-02 15:04:05"
web-path: ./dist

```

#### Add Static file path - You can add static file access path,through `AddStatic` function. ```go package main

import (

"github.com/kataras/iris/v12"
"github.com/snowlyg/iris-admin/server/web"

)

func main() {
	webServer := web_iris.Init()
    fsOrDir := iris.Dir(filepath.Join(dir.GetCurrentAbPath(), "/other"))
	webServer.AddStatic("/other",fsOrDir)
	webServer.Run()
}

```

#### Use with front-end framework , e.g. vue. - Default,you must build vue to the `dist` directory. - Naturally you can set this config key `web-path` to change the default directory. ```go package main

import (

"github.com/kataras/iris/v12"
"github.com/snowlyg/iris-admin/server/web"

)

func main() {
	webServer := web_iris.Init()
	webServer.AddWebStatic("/")
	webServer.Run()
}

```

Front-end page reference/borrowing: *notice: The front-end only realizes preview effect simply*
[gin-vue-admin](https://github.com/flipped-aurora/gin-vue-admin/tree/master/web)
[vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)

#### Example - [iris](https://github.com/snowlyg/iris-admin-example/tree/main/iris) - [gin](https://github.com/snowlyg/iris-admin-example/tree/main/gin)

#### RBAC - [iris-admin-rbac](https://github.com/snowlyg/iris-admin-rbac)

#### Unit test and documentation - Before start unit tests, you need to set two system environment variables `mysqlPwd` and `redisPwd`,that will be used when running the test instance。 - helper/tests(https://github.com/snowlyg/helper/tree/main/tests) package the unit test used, it's simple package base on httpexpect/v2(https://github.com/gavv/httpexpect). - [example for unit test](https://github.com/snowlyg/iris-admin-rbac/tree/main/iris/perm/tests) - [example for unit test](https://github.com/snowlyg/iris-admin-rbac/tree/main/gin/authority/test)

#### Thanks

Thanks [JetBrains](https://www.jetbrains.com/?from=iris-admin)' supports .

Source Files ¶

View all Source files

doc.go

Directories ¶

Path	Synopsis
g
migration
seed
server
cache
casbin
cron_server
database
database/orm
database/scope
operation
viper_server
web
web/tests
web/web_gin
web/web_gin/middleware
web/web_gin/request
web/web_gin/response
web/web_iris
web/web_iris/middleware
web/web_iris/validate
zap_server

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

IrisAdmin

项目地址

相关文档

交流方式

iris 学习记录分享

项目介绍

项目由多个服务构成,每个服务有不同的功能.

数据初始化

简单初始化.

自定义迁移工具初始化.

简单使用

启动项目

添加模块

设置静态文件路径

设置其他静态文件路径

配合前端使用

简单用例

RBAC

单元测试和接口文档

感谢

Documentation ¶

Overview ¶

Source Files ¶

Directories ¶