AngularJS 公共方法代码健壮性思考

Jenny_Tong 发布于2019-08-26 11:54 / 2076人阅读

摘要：这严重地影响了开发的效率。参数校验所以我们的公共方法既要写注释，让人能看懂，也要对每一个传入的参数表示怀疑。公共方法随手一条提示信息，节约程序员的万千时间。

公共方法

当我们写一些公共组件或方法时，我们可能需要接收外部的参数，但是，我们并不总能保证我们的注释是完全能让他人理解的。

/**
 * 获取所有考评员信息
 * @param   {district}    区域
 * @param   {department}  部门
 * @param   {discipline}  学科
 */
self.getAllExaminerInfoByDistrictAndDepartmentAndDiscipline = function(district, department, discipline) {
    // 设置请求参数
    var params = {
        districtId: district.id,
        departmentId: department.id,
        disciplineId: discipline.id
    };
    // 请求后台接口，返回
    return $http.get(baseUrl, { params: params });
};

错误使用

就像上面的这段代码，属于在Service中的公共方法，乍一看，可能看不出什么错误，我们注释写得好好的，我要个什么什么对象，用的时候传给我就好了。

编码常有失误，如果他人不小心传了个undefined进来。

var params = {
    districtId: district.id,
    departmentId: department.id,
    disciplineId: discipline.id
};

然后我们这段代码就是从undefined中获取属性，就会抛出错误。

当然，以软件工程师的骄傲，他不是先考虑自己哪里写错了，而是认为你这个公共的方法有问题，然后找写这个方法的人进行激烈地讨论，浪费了半个小时发现原来是参数传错了。这严重地影响了开发的效率。

参数校验

所以我们的公共方法既要写注释，让人能看懂，也要对每一个传入的参数表示“怀疑”。

公共方法，可能会有很多人使用，为了减少参数传错造成的时间浪费，所以我们需要在我们的逻辑真正地执行之前，对传入的参数进行校验。

我们可以对这几个传入的区域、部门、学科对象进行校验。

if (!district) {
    throw "未接收到区域信息";
}

这样，如果我们没有传该参数或传入一个undefined，我们的控制台就会报错，提示开发者“未接收到区域信息”。

这样，开发者就能准确而快速地定位错误，自己这个方法用错了，并且根据提示，是自己的区域信息传错了，这就减少了互相争论与讲解的成本。

公共方法随手throw一条提示信息，节约程序员debug的万千时间。

云服务器 GPU云服务器健壮性 html公共的代码代码方法信息 php代码加密方法

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/107794.html

是谁弄脏了我的代码

摘要：前篇文章一发，立马有程序猿说解气呀，我也待在这样的一个公司，所以我怎么能做出好的东西呢。现在不喷产品不喷测试不喷领导，仅仅从程序猿的角度说说，你都有做过哪些凑合的事，然后就凑出了一锅粥。这种无组织无纪律的行为是压垮骆驼的那根稻草。前篇文章一发，立马有程序猿说：解气呀，我也待在这样的一个公司，所以我怎么能做出好的东西呢。呵呵，那你误会我的意思了，我可没说哪种公司不好，我觉得经历过的...

tomener 2019-07-01 12:11 评论0 收藏0
是谁弄脏了我的代码

摘要：前篇文章一发，立马有程序猿说解气呀，我也待在这样的一个公司，所以我怎么能做出好的东西呢。现在不喷产品不喷测试不喷领导，仅仅从程序猿的角度说说，你都有做过哪些凑合的事，然后就凑出了一锅粥。这种无组织无纪律的行为是压垮骆驼的那根稻草。前篇文章一发，立马有程序猿说：解气呀，我也待在这样的一个公司，所以我怎么能做出好的东西呢。呵呵，那你误会我的意思了，我可没说哪种公司不好，我觉得经历过的...

yanest 2019-08-14 12:05 评论0 收藏0
19年一些微小的计划

摘要：是今年一定要学的东西这两年页面上用的三方组件多了，写的少了，的一些属性不太记得了，针对的学习计划有两个参照的样式进行学习参照的组件样式，学习如何处理样式与组件之间的关系，规范自己的写法。磕磕绊绊工作有几年了，前端界几乎每天都有新名词，令人眼花缭乱，目瞪狗呆。这两年一直在外包工作，业务写的多些，对js的基础掌握的还不是很到位。最近深感技术嗅觉迟钝，虽然平时也有看书学习，更多的时候都是断...

harriszh 2019-08-23 14:50 评论0 收藏0
颠覆微服务认知：深入思考微服务的七个主流观点

摘要：笔者对微服务系统的观点是，我们从单体系统向微服务系统改造的过程中，需要认真思考什么阶段使用微服务。此外，为了解决服务部署，我们可以考虑通过滚动发布来实现服务的无中断。事实上，微服务保证其服务的整体可用性。原文地址：梁桂钊的博客博客地址：http://blog.720ui.com 欢迎关注公众号：「服务端思维」。一群同频者，一起成长，一起精进，打破认知的局限性。一、逃离单体系统，...

XanaHopper 2019-08-19 10:29 评论0 收藏0