Ginframe：项目核心功能/场景

Ginframe：项目核心功能/场景

ginframe 基于Go语言gin框架搭建的可快速开发的微服务脚手架 项目地址: https://gitcode.com/gh_mirrors/gi/ginframe

项目介绍

Ginframe 是一个基于 Go 语言的 Gin 框架搭建的微服务脚手架，旨在帮助开发者快速上手、快速开发并高效地完成项目交付。它整合了一系列常用的开发组件和工具，让开发者可以避免重复造轮子，专注于业务逻辑的实现。

项目技术分析

Ginframe 使用了当前流行的技术栈，包括但不限于：

• Gin：高性能的 HTTP Web 框架
• GORM：强大的 ORM 库
• Redis：高性能的键值存储系统
• MongoDB：文档型数据库
• Elasticsearch：搜索引擎
• Kafka：消息队列
• JWT：JSON Web Token 用于用户认证
• Nacos：服务发现和配置管理
• Etcd：分布式键值存储系统

项目技术应用场景

Ginframe 适用于以下场景：

1. 快速构建微服务架构
2. 提供 RESTful API 服务
3. 实现分布式系统的服务发现和配置管理
4. 处理高并发的 HTTP 请求
5. 实现基于 Token 的用户认证
6. 支持多种数据库和缓存系统的集成

项目特点

1. 快速上手：Ginframe 提供了清晰的结构和丰富的示例代码，让开发者可以迅速熟悉项目结构和开发流程。
2. 高性能：基于 Gin 框架，Ginframe 在性能上有着先天优势，能够应对高并发场景。
3. 高扩展性：项目结构松耦合，易于扩展和维护，开发者可以根据实际需求添加或删除模块。
4. 丰富的功能：Ginframe 集成了多种常用工具和库，如动态搜索、分页、加密、敏感词过滤等，大大提高了开发效率。
5. 统一封装：对 API 返回格式进行了统一封装，提高了代码的可读性和一致性。

以下是一个基于 Ginframe 的项目结构示例：

server-common                         -- 服务公共模块
    config                            -- 解析配置方法
    const                             -- 全局常量
    driver                            -- 全局驱动
    nacosRF                           -- 全局nacos配置
    pkg                               -- 全局公共包
        gorm
        httprequest
        jwt
        leveldb
        mongo
        redis
        uber
        viper
        wetcd
        wkafka
    process                           -- cpu核心
    servers                           -- gprc 服务发现
    utils                             -- 全局工具类
        email                         -- 发送邮件
        encry                         -- 加密
        enum                          -- api统一分装返回
        ip                            -- ip工具
        maps                          -- map工具
        orm                           -- gorm动态搜索、分页
        regmatch                      -- 正则匹配
        slice                         -- 切片操作
        wordsfilter                   -- 敏感词过滤
        wtime                         -- 时间处理
server-user                           -- 用户服务
    boot                              -- 启动目录
        db.go
        grpc.go
        http.go
        init.go
        log.go
        ws.go
    cachedb                           -- 缓存操作
    core                              -- 核心目录
        db.go
    daos                              -- daos
    global                            -- user服务全局配置
    grpcservices                      -- grpc services
    handler                           -- 控制器
    input                             -- 入参
    middlewares                       -- 中间件
    models                            -- 模型
    out                               -- 出参映射
    pb                                -- protobuf生成的文件目录
    proto                             -- protobuf文件目录
    router                            -- 路由
        api.go
        ws.go
    rpc                               -- rpc
    scripts                           -- 脚本
    service                           -- 服务层
    ulogger                           -- 服务日志
    ws                                -- websocket
    main.go                           -- 入口文件
server-test                           -- 测试服务
......                                -- 其他服务
.gitignore
go.mod                                -- mod包管理文件
LICENSE
README.md

安装

安装 Ginframe 的步骤非常简单，只需要几个命令即可：

git clone https://github.com/jeffcail/ginframe.git

cd ginframe

make env

make mod

安装完成后，你可以根据自己的需求对项目进行修改和扩展。

Ginframe 作为一个功能丰富且易于扩展的微服务脚手架，无论是对于初学者还是经验丰富的开发者，都是一个不错的选择。它不仅能够提高开发效率，还能帮助开发者专注于业务逻辑的实现，从而快速交付高质量的项目。

ginframe 基于Go语言gin框架搭建的可快速开发的微服务脚手架 项目地址: https://gitcode.com/gh_mirrors/gi/ginframe