github.com/isyscore/isc-gobase@v1.5.3-0.20231218061332-cbc7451899e9/README.md (about)

     1  ![CI](https://github.com/isyscore/isc-gobase/actions/workflows/go.yml/badge.svg)
     2  
     3  # isc-gobase
     4  
     5  isc-gobase 框架是杭州指令集智能科技有限公司在java转go的实践中沉淀总结的一套至简化工具框架。遵从大道至简原则，让开发者在开发go的项目方面使用更简单
     6  
     7  ## 下载
     8  ```shell
     9  go get github.com/isyscore/isc-gobase
    10  ```
    11  提示：更新相关依赖
    12  ```shell
    13  go mod tidy
    14  ```
    15  
    16  ## 快速入门
    17  isc-gobase定位是工具框架，包含各种各样的工具，并对开发中的各种常用的方法进行封装。也包括web方面的工具
    18  ### web项目
    19  创建`main.go`文件和同目录的`application.yml` 文件
    20  
    21  ```text
    22  ├── application.yaml
    23  ├── go.mod
    24  └── main.go
    25  ```
    26  
    27  ```yaml
    28  # application.yml 内容
    29  base:
    30    server:
    31      # 是否启用，默认：false
    32      enable: true
    33  ```
    34  ```go
    35  // main.go 文件
    36  package main
    37  
    38  import (
    39      "github.com/gin-gonic/gin"
    40      "github.com/isyscore/isc-gobase/server"
    41      "github.com/isyscore/isc-gobase/server/rsp"
    42  )
    43  
    44  func main() {
    45      server.Get("api/get", GetData)
    46      server.Run()
    47  }
    48  
    49  func GetData(c *gin.Context) {
    50      rsp.SuccessOfStandard(c, "value")
    51  }
    52  ```
    53  运行如下
    54  ```shell
    55  root@user ~> curl http://localhost:8080/api/get
    56  {"code":0,"data":"value","message":"success"}
    57  ```
    58  
    59  ### 包列表
    60  |包名        | 简介 |
    61  | --------   | :----: |
    62  | [isc](/isc)| 基础工具（更新中）|
    63  | [config](/config)| 配置文件管理|
    64  | [validate](/validate)|校验核查 |
    65  | [logger](/logger)| 日志 |
    66  | [database](/database)|数据库处理（待更新） |
    67  | [server](/server)| 服务处理 |
    68  | [goid](/goid)| 局部id传递处理（theadlocal） |
    69  | [json](/json)| json字符串处理工具 |
    70  | [cache](/cache)| 缓存工具 |
    71  | [time](/time)| 时间管理工具 |
    72  | [file](/file)| 文件管理工具 |
    73  | [coder](/coder)| 编解码加解密工具 |
    74  | [http](/http)| http的辅助工具 |
    75  | [listener](/listener)| 事件监听机制 |
    76  | [bean](/bean)| 对象管理工具 |
    77  | [debug](/debug)| 线上调试工具统一介绍文档 |
    78  | [extend/orm](/extend/orm)| gorm、xorm的封装 |
    79  | [extend/etcd](/extend/etcd)| etcd封装 |
    80  | [extend/redis](/extend/redis)| go-redis的封装 |
    81  | [extend/emqx](/extend/emqx)| emqx客户端的封装 |
    82  
    83  ### isc-gobase 项目测试
    84  根目录提供go_test.sh文件，统一执行所有gobase中包的测试模块
    85  ```shell
    86  sh go_test.sh
    87  ```