2025年3月25日 星期二 甲辰(龙)年 月廿四 设为首页 加入收藏
rss
您当前的位置:首页 > 计算机 > 编程开发 > Go语言

Singo 轻量级基于 Golang 的 Web 服务框架

时间:12-14来源:作者:点击数:3
CDSY,CDSY.XYZ

使用 Singo 开发 Web 服务: 用最简单的架构,实现够用的框架,服务海量用户。

go-crud 正式改名为 Singo!项目地址:https://github.com/Gourouting/singo

目的

本项目采用了一系列 Golang 中比较流行的组件,可以以本项目为基础快速搭建 Restful Web API

特色

本项目已经整合了许多开发API所必要的组件:

  1. Gin: 轻量级Web框架,自称路由速度是golang最快的
  2. GORM(link:http://gorm.io/docs/index.html): ORM工具。本项目需要配合Mysql使用
  3. Gin-Session: Gin框架提供的Session操作工具
  4. Go-Redis: Golang Redis客户端
  5. godotenv: 开发环境下的环境变量工具,方便使用环境变量
  6. Gin-Cors: Gin框架提供的跨域中间件
  7. 自行实现了国际化i18n的一些基本功能
  8. 本项目是使用基于cookie实现的session来保存登录状态的,如果需要可以自行修改为token验证

本项目已经预先实现了一些常用的代码方便参考和复用:

  1. 创建了用户模型
  2. 实现了/api/v1/user/register用户注册接口
  3. 实现了/api/v1/user/login用户登录接口
  4. 实现了/api/v1/user/me用户资料接口(需要登录后获取session)
  5. 实现了/api/v1/user/logout用户登出接口(需要登录后获取session)

本项目已经预先创建了一系列文件夹划分出下列模块:

  1. api文件夹就是MVC框架的controller,负责协调各部件完成任务
  2. model文件夹负责存储数据库模型和数据库操作相关的代码
  3. service负责处理比较复杂的业务,把业务代码模型化可以有效提高业务代码的质量(比如用户注册,充值,下单等)
  4. serializer储存通用的json模型,把model得到的数据库模型转换成api需要的json对象
  5. cache负责redis缓存相关的代码
  6. auth权限控制文件夹
  7. util一些通用的小工具
  8. conf 放一些静态存放的配置文件,其中locales内放置翻译相关的配置文件

Godotenv

项目在启动的时候依赖以下环境变量,但是在也可以在项目根目录创建.env文件设置环境变量便于使用(建议开发环境使用)

  • MYSQL_DSN="db_user:db_password@/db_name?charset=utf8&parseTime=True&loc=Local" # Mysql连接地址
  • REDIS_ADDR="127.0.0.1:6379" # Redis端口和地址
  • REDIS_PW="" # Redis连接密码
  • REDIS_DB="" # Redis库从0到10
  • SESSION_SECRET="setOnProducation" # Seesion密钥,必须设置而且不要泄露
  • GIN_MODE="debug"

Go Mod

本项目使用 Go Mod 管理依赖。

  • go mod init go-crud
  • export GOPROXY=http://mirrors.aliyun.com/goproxy/
  • go run main.go // 自动安装

运行

  • go run main.go

项目运行后启动在 3000 端口(可以修改,参考 gin 文档)

CDSY,CDSY.XYZ
方便获取更多学习、工作、生活信息请关注本站微信公众号城东书院 微信服务号城东书院 微信订阅号
推荐内容
相关内容
栏目更新
栏目热门
本栏推荐