写点什么

像产品设计一样思考、像程序运行一样执行

用户头像
水色
关注
发布于: 2020 年 04 月 27 日
像产品设计一样思考、像程序运行一样执行

我很喜欢“工程师”这个叫法,坚持认为绝大部分软件研发从业者都是工程师。工程师,顾名思义就是工程层面的专业人士,核心是解决工程应用层面的问题。

软件工程师是机器算法与现实世界的中间件,更多需要考虑的是用技术来解决现实世界问题。比如工程师并不需要研发 md5 等算法,但必须掌握如何开发安全的登录功能。云服务的时代,工程师拥有了更强大的能力。

请注意:下文里都统一用工程师来称呼软件产品的研发人员,即软件工程师。



回到软件研发本身,工程师就是要做出好产品。软件产品是由代码构成的,好产品一定来自于好代码,但要写出一份好代码,可不仅仅是只懂得写代码就可以的。任何一位工程师,都应该像产品经理一样思考产品需求问题,只有充分掌握了需求,并对于业务需求变化有一定的预判,才能写出好的代码实现。下面用一个工作中出现过的例子来详细解释一下。



问题:Emoji 表情渲染差异



曾经做通讯产品研发时,各种iOS、Android、浏览器等对于 Emoji 渲染有很多差异,同一个 Emoji 表情在不同设备会有较大显示差异,有些老旧设备设置不支持,会直接出现 “”,。



要解决问题,首先得搞清楚 Emoji 渲染差异到底是什么问题。

1. Emoji 是什么?渲染差异又是怎么回事?



调研后的结论摘录

Emoji 是什么?Emoji 是文字,只是长得像图,从提出后,因为表现形式的丰富,越来越流程,Android、iOS、Web等平台也都逐渐进行了支持,同时 Emoji 的数量也在不断的扩充中。



根据标准协议,每个 Emoji 都有唯一的 unicode 码,但是渲染后长什么样子,都是各平台自行实现,苹果、安卓以及各浏览器都分别设计了自己的图标并内置渲染使用,如下图,都不太一样。



V11.0 Lists http://unicode.org/emoji/charts/full-emoji-list.html



还了解到不同图标有着不同的版权声明,学习了很多 Emoji 的掌故,比如小人表情的肤色争议、裸露身体表情与伊斯兰世界禁忌等。



几个需要用到的结论:



  1. Android、iOS 都支持原生 Emoji 渲染

  2. 大部分桌面浏览器都支持原生 Emoji 渲染

  3. 输入法里使用的图标只能是平台默认的

  4. 移动浏览器、小程序环境都支持 原生 Emoji 渲染



2. 设计解决思路



限于篇幅和专业方向仅 web 部分

  1. 使用 unicode 作为 Emoji 唯一标识

  2. 对于支持 Emoji 渲染

  3. 对于不支持 Emoji 的老浏览器,使用图片填充(因为 Emoji 数量太多,只处理常用的 100多个,并对使用者提供新增 Emoji 表情图片的扩展方法),版权是务必要注意的问题

  4. 解决方案分离出来,处理成通用的 sdk,并支持 AMD、CMD协议



这个环节非常难,需要考虑用户体验、技术可行性、性能、成本等因素,但却又非常重要,一定要严格对待认真商讨,定义出一个合理的方案。但凡这个环节没有认真对待的,几乎必然进入无法交付的灾难,问题会蔓延到 QA 等其他团队。



工作到这,具体的问题就搞清楚了,也确定了解决思路。但就我工作中的观察,这恰恰是最缺失的一部分,最后几乎都导致一定程度的灾难。



3. 开发准备工作阶段

先处理好 sdk 的加载调用方法,首先处理 sdk 自身与项目引用的关系



"use strict"; //严格模式

/
模块化: http://www.ruanyifeng.com/blog/2012/10/javascript_module.html

es6 module: http://es6.ruanyifeng.com/#docs/module
CMD规范: https://github.com/seajs/seajs/issues/242
AMD规范: https://github.com/amdjs/amdjs-api/wiki/AMD

requirejs: http://requirejs.org/docs/whyamd.html
/

;(function (global, factory,namespace) {
if(typeof exports === 'object' && typeof module !== 'undefined'){
module.exports = factory();
}else if(typeof define === 'function' && define.amd){
define(factory);
}else{
global[namespace] = factory();
}
})(window, function(){
/
从这里开始写代码
/
}, namespace);



4. 定义



通过注释把之前思路和调研落实到纸面,个人习惯通过注释加入必要的参考链接;定义需要实现的方法,sdk 对外提供的方法,脑补实现过程做必要的补充,用 return 写一些伪实现;根据业务逻辑粗略定义参数,不需要拘泥于具体的数据类型,只需要跑业务逻辑,关键是快,多快速跑几遍更好



emoji参考资料:

https://github.com/maicong/Twitter-Emoji
http://blog.getemoji.com/post/57054354336/which-browsers-support-emoji

http://caniemoji.com/
https://gist.github.com/mwunsch/4710561

http://www.fileformat.info/info/unicode/char/1f436/index.htm
/

/ 工具类 /
var utils = {
subs : function(template, data) {
},
getEmoji : function(emojiUnicode){
},
errorReport : function(error){
console.log(error);
}
};

var isSupport = (function(){
})();

/emoji支持情况/
var supportList = {
};

function getEmojiImage(emojiUnicode){
}

function getEmojiName(emojiUnicode){
}

function getEmojiAuto(emojiUnicode){
}

return {
utils : utils,
getName : getEmojiName,
show : function(emojiUnicode,type){
if(type == "emoji"){
return utils.getEmoji(emojiUnicode);
}else if(type == "image"){
return getEmojiImage(emojiUnicode);
}else{
return getEmojiAuto(emojiUnicode);
}
},
init : function(config){
/
config = {
emojis : {
"u1F600":{},
},
size : "20px",
type : "auto/image/emoji"
}
*/
}
}



5. 复核,完成精准定义



复核所有的函数、参数、变量的定义与命名,通过代码+注释明确落实到纸面

有实现的逻辑直接 copy 贴入,无实现的逻辑可以用伪代码实现,确保调用

配合必要的调用示例或单元测试等,后期可以作为质量保证手段

到这必须要输出一份可以运行的代码,通过运行调试确保所有工作的正确与合理



"use strict";

/
es6 module: http://es6.ruanyifeng.com/#docs/module
CMD规范: https://github.com/seajs/seajs/issues/242
AMD规范: https://github.com/amdjs/amdjs-api/wiki/AMD

requirejs: http://requirejs.org/docs/whyamd.html
/

;(function (global, factory,namespace) {
if(typeof exports === 'object' && typeof module !== 'undefined'){
module.exports = factory();
}else if(typeof define === 'function' && define.amd){
define(factory);
}else{
global[namespace] = factory();
}
})(window, function(){
/
emoji参考资料:

https://github.com/maicong/Twitter-Emoji
http://blog.getemoji.com/post/57054354336/which-browsers-support-emoji

http://caniemoji.com/
https://gist.github.com/mwunsch/4710561

http://www.fileformat.info/info/unicode/char/1f436/index.htm

http://www.ruanyifeng.com/blog/2017/04/emoji.html
/

/ 工具类 /
var utils = {
/
template = '<p>{{this.key2}}, <b>{{this.key1.key11}}</b></p>';
data = {
"key1": {
"key11" : "value11"
},
"key2" : "value2"
};
data = [data,data]
/
subs : function(template, data) {
template = template || "";
data = data || [""];
var re = /{{((?:(?!}}).)+)}}/g, reExp = /(^( )?(var|if|for|else|switch|case|break|{|}))(.)?/g, code = 'var r=[];\n', cursor = 0;
var add = function(line, js) {
js? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n') :
(code += line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : '');
return add;
}
var match;
while(match = re.exec(template)) {
add(template.slice(cursor, match.index))(match[1], true);
cursor = match.index + match[0].length;
}
add(template.substr(cursor, template.length - cursor));
code += 'return r.join("");';

data = isNaN(data.length) ? [data] : data;
var html = "";
for(var i = 0, length = data.length; i < length; i++) {
html += new Function(code.replace(/[\r\t\n]/g, '')).apply(data[i]);
}
return html;
},

/
emojiUnicode = "u1F600";
/
getEmoji : function(emojiUnicode){
var emojiUnicode = "u1F600";
var code = "0x" + emojiUnicode.replace("u","");
var emoji = String.fromCodePoint(code);
return emoji;
},

/
error = {
"module" : "voip/emoji/voice/sdk"
"code" : -1,
"info" : "网络超时 timeout"
};
/
errorReport : function(error){
console.log(error);

var api = "http://domain?data="
var data = JSON.stringify(error);
console.log(api + encodeURIComponent(data));
}
};

var isSupport = (function(){
return Math.random() > 0.5 ? true : false;
})();

/emoji支持情况/
var supportList = {
"windows" : {
"Chrome41+" : true, / Chrome 41 开始支持 Emoji 显示(全平台) /
"Firefox50+" : true, /Firefox 50 开始支持 emoji 支持 /
"Chrome" : false
},
"Mac" : {
"Chrome41+" : true,
"Firefox50+" : true,
"Chrome" : false
},
"Android" : true, //小米有问题
"iPhone" : true
};

function getEmojiImage(emojiUnicode){
return '<span class="emoji-1f600">[大笑]</span>';
}

function getEmojiName(emojiUnicode){
return {
"en" : "[grinning]",
"cn" : "[大笑]"
};
}

function getEmojiAuto(emojiUnicode){
if(isSupport){
return utils.getEmoji(emojiUnicode);
}else{
return getEmojiImage(emojiUnicode);
}
}

return {
utils : utils,
getName : getEmojiName,

// getEmojiAuto : getEmojiAuto,
// getEmojiImage : getEmojiImage,


/
type = "auto/image/emoji"
/
show : function(emojiUnicode,type){

if(type && type!= "auto" && type!= "image" && type!= "emoji"){
var error = {
"module" : "emoji",
"code" : 10001,
"info" : "wrong type,type only can be auto,image,emoji,empty-string"
};
utils.errorReport(error);
}

if(type == "emoji"){
return utils.getEmoji(emojiUnicode);
}else if(type == "image"){
return getEmojiImage(emojiUnicode);
}else{
return getEmojiAuto(emojiUnicode);
}
},
init : function(config){
/
config = {
emojis : {
"u1F600":{
"en":"grinning",
"cn":"狂笑",
"position":"0px 0px"
"image" : "1f600.svg"
},
},
size : "20px",
type : "auto/image/emoji"
}
/
}
}
}, "Emoji");

/
Emoji.show("u1F600","auto");
Emoji.show("u1F600");
Emoji.getName("u1F600").en;
*/



至此,才开始进入真正的代码实现,但一路顺下来不难发现,其实大部分的工作已经做完了,剩下的就只是具体已经定义好输入输出方法的实现,不管谁来实现,都不会影响整体调用。



开发里有句话叫“依赖于接口,不依赖于实现”,在这儿,我想说,设计和流程大于实现,实现可以差一点,可以随时改进,但整体的解决方法、调用流程是应该第一时间既定的,定义好后就可以同步开始做文档、调用示例、测试验证等工作,同时又极大的降低了沟通成本。



同时我们也会发现,要完成这个既定,代码之外的综合能力要求其实是非常高的,对于软件运行环境、硬件、外部世界的现实、用户等都需要有一定的认知,要观察分析总结,要条理表达,要强于设计,当然还必须要能输出优秀的文档。经常开玩笑说,写代码真的不难,大家都可以学会,但写代码之前的这些一时半会还真的学不会。



------



PS:本文着重于工程师的工作流程与方法,选择性的忽略掉了组件设计与开发、相关的设计模式等技术性内容,模块化虽然专业但属于范式,只有第 5 步是专业的代码研发,前 4 步只要懂产品技术的常识就可以完成这样的设计,关键是方法论,方法对,都可以来做工程师。



发布于: 2020 年 04 月 27 日阅读数: 174
用户头像

水色

关注

大事化小 小事做好 2020.04.27 加入

马拉松工程师,技术管理者,习惯性总结改进一切的细节控。

评论

发布
暂无评论
像产品设计一样思考、像程序运行一样执行