黔江区 盐边县 台中市 灵山县 黄大仙区 北碚区 昭通市 东至县 健康 平度市 通城县 民勤县 阜城县 阿拉善左旗 丹江口市 安溪县

文章导航软件下载单机游戏安卓资源苹果资源

pc软件新闻网络操作系统办公工具编程服务器软件评测

安卓新闻资讯应用教程刷机教程安卓游戏攻略tv资讯深度阅读综合安卓评测

苹果ios资讯苹果手机越狱备份教程美化教程ios软件教程mac教程

单机游戏角色扮演即时战略动作射击棋牌游戏体育竞技模拟经营其它游戏游戏工具

网游cf活动dnf活动lol周免英雄lol礼包

手游最新动态手游评测手游活动新游预告手游问答

您的位置:单机游戏角色扮演 → 怪物猎人世界新装备介绍 怪物猎人世界新装备新系统一览

美金对人民币的汇率_Go 实现 自动检索 API 错误码代码行 并 打印成文档,例 markDown 形式等

标签:城垛 国际象棋开局百科全书a

作者:林冠宏 / 指尖下的幽灵

掘金:https://juejin.im/user/587f0dfe128fe100570ce2d8

博客:http://www.cnblogs.com.h5c5o2n.tw/linguanh/

GitHub : https://github.com/af913337456/

腾讯云专栏: https://cloud.tencent.com/developer/user/1148436/activities


源码--GitHub:https://github.com/af913337456/ErrorDocAutoPrinter

如果你是一个后端Server程序开发人员。你应该知道,在你写完API之后,是需要给客户端的同学提供调用文档的。

例如下面一个api handler创建一个用户

func HandleCreateUser(w http.ResponseWriter,r *http.Request) map[string]interface{} {
    if r.Body == nil {
        return util.GetCommonErr(23,"create user req body is fucking null?")
    }
    ....
    ....
    return util.GetCommonSuccess("success")
}

上面有一行错误信息输出的代码

util.GetCommonErr(23,"create user req body is fucking null?")

假设我们要写成markDown风格的文档,上面的可能是这样一种对应

错误码 含义 提示
23 create user req body is fucking null? 暂无

Ok,这只是一个错误信息的情况,我们很轻松就手动写完了。

如果有几百上千个呢?一个完整的服务端程序,肯定会有很多这种错误信息输出的代码。在几百上千个的时候,还要手动写?这是多么低效率,且浪费时间令人窒息的操作。

而我这篇文章要介绍的就是一个帮你自动检索并生成API输出错误信息文档开源程序

ErrorDocAutoPrinter

它,具备下面的特点

  • 自定义代码文件夹路径
  • Json 配置文件形式导入设置,避免反复编译程序
  • 按照给定的代码方法名称自动检索对应的代码行
  • 按照给定的切割参数规则,自动切割组合
  • 按照给定的列名描述,自动组合成新的文字
  • 接口化的设计逻辑,高度自定义
  • 自动按照code 从小到大排序输出,可控!
  • 自动提示重复出现过的错误信息。
  • 自动按照设定生成输出文件
  • 可设置符合目标的文件后缀
  • 可设置需要过滤的文件名,符合就不处理
  • 自定义输出风格,markDown?txt?html?
  • 自行定义输出的逻辑,可以映射到很多情况的文字玩法
  • 总之:‘为所欲为’

我,提供了两种风格的输出

  • 简单文本 风格
  • markDown 风格

使用步骤

  1. 配置好json文件 DefaultConfig.json
{
  "TargetFileSuffix":[".go"],
  "TargetErrorFuncName":["util.GetCommonErr","util.GetErrWithTips"],
  "FilterFileName":["core"],
  "ParamsColumnNames":[" 错 误 码 "," 含 义 ","提 示"],
  "ParamsSplitChar":","
}
  1. 输入你的代码文件夹路径并运行程序
func TestDocPrinter(t *testing.T) {
    p := NewDefaultErrorDocPrinter(NewDefaultMarkDownErrorDocPrinter())
    if p == nil {
        return
    }
    fmt.Println(p.printErrorDoc("../../errorDocPrinter"))
}
  1. 复制粘贴结果
错误码 含义 提示
-9 invalid create user --空缺--
-4 invalid create user --空缺--
-1 create user failed 创建用户失败
88 创建评论失败 --空缺--
3110 error params --空缺--
3111 update failed --空缺--
3112 yellow 内容涉黄 --空缺--
3113 forbid 禁止访问 --空缺--
3114 empty id --空缺--
3115 服务端开启事务失败 --空缺--
3116 服务端事务提交失败 --空缺--
3117 update effect row <= 0 --空缺--
3118 RowsAffected 失败 --空缺--
3119 更新只有部分成功 --空缺--
3120 empty userId --空缺--
3121 too lager --空缺--
3122 user not exits --空缺--
3123 非法更新 --空缺--
3124 参数个数长度限制 --空缺--
3126 服务端事务提交失败 --空缺--
3127 invalid money --空缺--
3128 money not enough --空缺--
3129 创建消费记录失败 --空缺--
基本说完调解面对面_2018年最新新闻网了,源码见上面的开源链接,去玩吧。

简单分析下 markDown 风格的生成

接口

type IErrorDocPrinter interface {
    FindLines(一袋女王_2018年最新新闻网printer *ErrorDocPrinter,reader *bufio.Reader,fileName,currentSuffix string,handleLine func(line string)) []string
    BuildACell(printer ErrorDocPrinter,columns,size int,prefixName,param string) string
    ResultLine(line string)
    EndOfAFile(printer ErrorDocPrinter,aFileRetLines []st天地争霸美猴王_2018年最新新闻网ring)
    EndOfAllFile(printer ErrorDocPrinter,allRetLines []string)
}

找到一个文件所有行

func (p MarkDownErrorDocPrinter) FindLines(
    printer *ErrorDocPrinter,reader *bufio.Reader,fileName,currentSuffix string,handleLine func(line string)) []string {
    // 正则匹配 todo
    var lines []string
    printer.currentLineNum = 0
    for {
        byt, _, err := reader.ReadLine()
        if err != nil {
            // 读完一个文件
            break
        }
        line := string(byt)
        // 排除注释
        printer.currentLineNum++
        if startWith(line,"//") {
            continue
        }
        if startWith(line,"/*") {
            continue
        }
        if startWith(line,"*") {
            continue
        }
        for _,value := range printer.TargetErrorFuncName {
            if strings.Contains(line,value) {
                // hit,准备生成
                handleLine(line)
                lines = append(lines,line)
            }
        }
    }
    return lines
}

处理一个单元格

func (p MarkDownErrorDocPrinter) BuildACell(
printer ErrorDocPrinter,columns,size int,prefixName,param string) string {
    /**
    | Name | Academy | score |
    | - | - | - |
    | Harry Potter | Gryffindor| 90 |
    | Hermione Granger | Gryffindor | 100 |
    | Draco Malfoy | Slytherin | 90 |
    */
    if columns == 0 {
        code,err := strconv.ParseInt(param,10,64)
        if err == nil {
            codeArr = append(codeArr,code)
        }
   米奇妙妙屋_2018年最新新闻网     return "|" + param
    }
    count := tipsMap[param]
    if columns == 1 {
        // 保存提示列
        if count != 0 {
            count++
            diffMap[fmt.Sprintf("param: -- %s -- times:%d",param,count-1)] =
                fmt.Sprintf(" 与 %s 的第 %d 行提示重复",printer.currentFileName,printer.currentLineNum)
        }else{
            count = 1
最强狂兵_2018年最新新闻网        }
        tipsMap[param] = count
    }
    if columns == size - 1 {
        return "|" + param + "|"
    }
    // 找出提示一样,但是 code 不一样的
    return "|" + param
}

从小到大排序--code

func quickSort(arr *[]int64,left,right int) {
    if arr == nil {
        return
    }
    if right == len(*arr) {
        right--
    }
    if left < 0 || left >= len(*arr) {
        return
    }
    hight := right
    low   := left
    base  := (*arr)[left]
    if low < hight {
        for ;low < hight; {
            for ;low < hight && base <= (*arr)[hight]; {
                hight--
                break
            }
            (*arr)[low] = (*arr)[hight]
            for ;low < hight && base >= (*arr)[low]; {
                low++
                break
            }
            (*arr)[hight] = (*arr)[low]
        }
        (*arr)[low] = base
        quickSort(arr,left,low-1)
        quickSort(arr,low+1,right)
    }
}

组装


quickSort(&codeArr,0,len(codeArr))
codeArrSize := len(codeArr)
for i:=0; i<codeArrSize ;i++ {
    codeAtr := strconv.Itoa((int)(codeArr[i]))
    index := 0
    for _,line := range allRetLines {
        if strings.Contains(line,"|"+codeAtr+"|") {
            final = append(final,line)
            // 减去一个,减少循环次数
            //retLines = append(retLines[:index],retLines[index+1:]...)
            index--
            break
        }
        index++
    }
马鞍山_2018年最新新闻网}

// 生成文件
fileName := "errorInfo.md"
file,err := os.Create(fileName)
defer file.Close()
if err!=nil {
    fmt.Println(err)
}
for _,line := range final {
    fmt.Println(line)
    file.WriteString(line+"
")
}

如果编程不是为了让复杂的问题简单化,那和机械学习有什么区别?

当前文章:http://9ukd1x61j-daoheli-com.h5c5o2n.tw/0nb/0b486_152603.html

发布时间:2019-07-21 01:26:46

银河娱乐官网yh163am.com  银河娱乐官网yh163am.com  银河国际手机网址2949  澳门银河手机网站  澳门银河娱乐送彩金网站  银河娱乐在线官方网址李易峰凌晨发文庆31岁生日 何炅魏大勋等送祝福  澳门银河官网真人娱乐  银河国际手机网址2949  SpaceX飞船返航:龙飞船回收情况良好收获颇丰  919银河优越会  

相关阅读 vivo NEX全面屏要来,OPPO也祭出大杀器Find X腾讯自动驾驶汽车首次亮相交通展23岁黑客被控受雇于俄间谍侵入电邮,获刑5年浙江义乌王阡一村谋乡村振兴之路1180马力!这台换了“引擎”的奥迪RS3让法拉利都只能看它尾灯西藏那曲发生4.2级地震 震源深度5千米河南:8200万亩小麦已收获146万亩.netcore mvc docker环境jenkins一键部署(DevOps)

文章评论
发表评论

热门文章 小米8/透明探索版现场实拍图赏:手机穿上“露背装”中国移动 “一号双终端”业务正式启动揭秘公务员考试阅卷现场:原来考分是这样出炉的小米荣耀联想同时出来吓人,就问你怕不怕

最新文章 “史上最大ICO”重头戏开场:切换主网后,EOS会分叉吗?朝鲜加紧维修铁路试运火车 为多国记者团提供方便 美财政部宣布制裁5名伊朗人 指其向也门胡塞武装提供支持实战技能:小小微信支付业务,何必虚惊一场腾讯动漫携电竞漫画亮相京交会 电竞专题展区亮点频频黑洞如何吞噬恒星?将其撕扯成碎片并释放强烈辐射

人气排行 腾讯起诉今日头条系,索赔1元并要求道歉小米VR一体机,你想知道的都在这里电动汽车充电是件烦心事!特斯拉“玩蛇”,宝马要做无线充思南县瓮溪镇:辣椒搭好致富桥上海一民办幼儿园多名幼儿面部被划伤 涉事老师被刑拘园长被免职2119万元!巴菲特午餐价格出炉,中拍者身份神秘工人日报评楼盘摇号内定:必须压缩“打招呼”的权力空间音频接收发射一机搞定,电脑/电视/音箱/功放有线变蓝牙的利器