[toc]

如何写出不好的代码

这是一个从各个项目整理出来的代码，具有一定代表性。坏代码的产生，本篇暂时不深究原则，仅挑选在开发中遇到的代码。

变量命名让人感到疑惑

ismd5 := false

这个 ismd5 从名字上看，似乎是表明是不是md5值，但实际上代码里面是表示imei是不是md5值，看下面的实际代码

srcImei := imei //原始imei
if ismd5 == false {
    has := md5.Sum([]byte(imei))
    imei = hex.EncodeToString(has[:])
}

实际上 ismd5 这个值出现的地方非常早，但用到这个变量值是在另一个文件的另一个方法里面，初始看代码的人可能对这个 ismd5 变量名一头雾水。

推荐命名规范

• 具体可参考 google开源项目风格指南

过多if else分支

直接看代码示例

var priorBountyDistance string
if priorBountyInfo.Rank == 0 {
    priorBountyDistance = "现在处在第xx名，请继续保持"
} else {
    priorInviters, err := bir.dao.GetInviters(priorBountyInfo.Rank, priorBountyInfo.Rank)
    if err != nil {
        return nil, err
    }
    if len(priorInviters) == 1 {
        priorInviter := priorInviters[0]
        inviteCount := int(math.Ceil(float64(priorInviter.StepCount+1-myself.StepCount) / float64(irc.StepCountPerInvitee)))
        if priorBountyInfo.FullBounty == 0 {
            if myBountyInfo.FullBounty == 0 {
                priorBountyDistance = fmt.Sprintf("距离获得$%.0f$xx仅需邀请$%d$人", float64(priorBountyInfo.Bounty)/100, inviteCount)
            } else {
                priorBountyDistance = fmt.Sprintf("距离第$%d$名仅需邀请$%d$人", priorBountyInfo.Rank, inviteCount)
            }
        } else {
            priorBountyDistance = fmt.Sprintf("距离前$%.0f%%$仅需邀请$%d$人", priorBountyInfo.RelRank*100, inviteCount)
        }
    }
}

推荐做法

• 提前取反，快速失败
• 运用策略模式，构建分支

查询和修改不分离

func checkIsRepeatImei(imei, channelID string) (bool, error) {
    num, err := redis.AddClientReportImei(imei)
    if err != nil {
        log.Error("redis.AddClientReportImei(%v) error(%v)", imei, err)
        return true, err
    }
    if num == 0 {
        log.Error("Repeat IMEI(%v) from cache, ChannelID(%v).", imei, channelID)
        return true, nil
    }
    return false,nil
}

这个checkIsRepeatImei是一个检查imei是否是重复的方法，但是里面是通过向redis添加一个记录来实现，这个方法有副作用，也就是你本来是不存在的，调用一下就存在了。一个查询方法居然会修改数据。

推荐做法

• 将查询和修改分离

超长方法

• 一个方法代码长度达到1000行方法，可能有的人觉得这怎么会发生。但事实上我们的代码里面经常出现。最常出现的场景是，这个方法是之前的人写的，我只是添加一点点逻辑，然后随着后面的迭代，换一个人又来加一些逻辑，越加越多。
• 此处就不贴代码了