Go 项目推荐之 go-admin

2020年7月1日 214点热度 0人点赞 0条评论
点击上方蓝色“Go语言中文网”关注我们,领全套Go资料,每天学习 Go 语言

go-admin 是一个go语言开发的企业级快速开发平台,使用了Gin,casbin,gorm,Vue,Element UI,并且也内置了一些模块,如:用户管理、部门管理、角色用户、菜单及按钮授权、数据权限、系统参数、日志管理等。

特性

  • 遵循 RESTful API 设计规范

  • 基于 GIN WEB API 框架,提供了丰富的中间件支持(用户认证、跨域、访问日志、追踪ID等)

  • 基于Casbin的 RBAC 访问控制模型

  • JWT 认证

  • 支持 Swagger 文档(基于swaggo)

  • 基于 GORM 的数据库存储,可扩展多种类型数据库

  • 配置文件简单的模型映射,快速能够得到想要的配置

  • 代码生成工具

  • 表单构建工具

  • TODO: 单元测试

内置

  1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
  2. 部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
  3. 岗位管理:配置系统用户所属担任职务。
  4. 菜单管理:配置系统菜单,操作权限,按钮权限标识等。
  5. 角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
  6. 字典管理:对系统中经常使用的一些较为固定的数据进行维护。
  7. 参数管理:对系统动态配置常用参数。
  8. 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
  9. 登录日志:系统登录日志记录查询包含登录异常。
  10. 系统接口:根据业务代码自动生成相关的api接口文档。
  11. 代码生成:根据数据表结构生成对应的增删改查相对应业务,全部可视化编程。
  12. 表单构建:自定义页面样式,拖拉拽实现页面布局。
  13. 服务监控:查看一些服务器的基本信息。

快速开始

服务

设置工作路径

mkdir goadmin
cd ./goadmin
mkdir src
cd ./src

为什么要设置src目录

因为 GO 的包搜索是从 GOPATH 和 GOROOT 路径下搜索,源码必须要放在 GOROOT 或 GOPATH 的 src 目录下才能找到。但把源码和包放在一起,对于很多人来说确实不太很习惯,有一种做法,通过在 GOPATH 中设置两个路径,go get 下载的包默认放在 GOPATH 设置的第一个路径下。比如,GOPATH 设置如下:

export GOPATH=/Users/zhangwenjian/go/:/Users/zhangwenjian/Work/go

如此就可以把工作区设在 /Users/zhangwenjian/Work/go/src,而安装包放在 /Users/zhangwenjian/go/src。

下载源码

git clone https://github.com/wenjianzhang/go-admin.git

编译

cd ./go-admin
go build

设置数据库

首先找到配置文件,config/settings.yml, 同时也可创建开发环境配置,只需将默认配置文件 config/settings.yml 复制到 config/settings.dev.yml 就好了

图片

settings:
  application:  
    # 项目启动环境            
    mode: dev  # dev开发环境 test测试环境 prod线上环境;
    host: 0.0.0.0  # 主机ip 或者域名,默认0.0.0.0
    # 服务名称
    name: go-admin   
    # 服务端口
    port: 8000   
    readtimeout: 1   
    writertimeout: 2 
  log:
    # 日志文件存放路径
    dir: temp/logs
  jwt:
    # JWT加密字符串
    secret: go-admin
    # 过期时间单位:秒
    timeout: 3600
  database:
    # 数据库名称
    name: dbname 
    # 数据库类型
    dbtype: mysql    
    # 数据库地址
    host: 127.0.0.1  
    # 数据库密码
    password: password  
    # 数据库端口
    port: 3306       
    # 数据库用户名
    username: root   

首先,需要修改数据库信息:

database: 节点下是数据库配置类信息
database.database: 数据库名称
database.dbtype: 数据库类型。目前支持:mysql
database.host: 数据库地址,填写网络ip地址或者域名。mysql类型,如:127.0.0.1;
database.password: 数据库密码
database.port: 数据库端口号
database.username: 数据库用户名

数据库结构初始化

项目中支持使用命令方式初始化基本数据结构和基础数据。可以方便的使用 init 命令进行项目数据库结构和数据初始化。如下操作:

./go-admin init -c=config/settings.dev.yml

:::tip
可以通过 -c 参数实现本地多环境配置文件隔离 例如 开发环境命名为:settings.dev.yml
:::

启动

初始化完成之后,我们就可以启动项目了,在这里需要注意一点,正常大家启动项目的方式是这样的 ./go-admin , 哦哦 系统报错了,我们尝试一下 ./go-admin

./go-admin

下图是输出内容:

图片

输出内容告诉我们:Error: requires at least one arg ,至少有一个参数;

你也可以使用./go-admin -h 来查看帮助;

上面讲完之后,我们就可以使用自己的启动语句来启动项目了,

./go-admin server -c=config/settings.dev.yml

如果看到一下数据内容,请检查一下数据库配置;

2020/04/06 23:38:52 root:password@tcp(127.0.0.1:3306)/dbname
2020/04/06 23:38:52 mysql connect error %v dial tcp 127.0.0.1:3306: connect: connection refused

输出内容为下图,恭喜你!你已经成功了!

图片

go,下一步启动前端项目!

视图

设置视图工作路径

返回上上级目录

cd ../../

下载视图源码

这里我们直接git clone下来。

git clone https://github.com/wenjianzhang/go-admin-ui.git

输出内容:

$ git clone https://github.com/wenjianzhang/go-admin-ui.git
Cloning into 'go-admin-ui'...
remote: Enumerating objects: 584, done.
remote: Counting objects: 100% (584/584), done.
remote: Compressing objects: 100% (436/436), done.
remote: Total 584 (delta 127), reused 524 (delta 88), pack-reused 0
Receiving objects: 100% (584/584), 580.92 KiB | 16.00 KiB/s, done.
Resolving deltas: 100% (127/127), done.

恭喜!到目前为止说明go-admin-ui代码已经下载完成。

npm install

 cd go-admin-ui/

 npm i  

 #
 npm i   --registry=https://registry.npm.taobao.org   # 国内请使用  

这里还原包是需要一些时间的请耐心等待一下...

看到下边的输入说明已经安装好了

Binary found at /Users/zhangwenjian/Code/go-test/go-admin-ui/node_modules/node-sass/vendor/darwin-x64-64/binding.node
Testing binary
Binary is fine
added 2033 packages from 1953 contributors in 40.229s

启动

启动项目,使用npm run dev命令就好了。

npm run dev

输出内容:

 DONE  Compiled successfully in 22188ms                                                                                                         12:47:40 AM


  App running at:
  - Local:   http://localhost:9530/
  - Network: http://192.168.3.12:9530/

  Note that the development build is not optimized.
  To create a production build, run npm run build.

此时项目已经启动了,但是有一点请注意:检查api是否也启动了。否则页面会提示错误的哦。

搞定

搞定,现在你可以go-admin 之旅!

推荐阅读



喜欢本文的朋友,欢迎关注“Go语言中文网

图片

Go语言中文网启用微信学习交流群,欢迎加微信:274768166,投稿亦欢迎

36420Go 项目推荐之 go-admin

这个人很懒,什么都没留下

文章评论