论坛推荐：怎样写出好的脚本-流程的开发与建立

admin

我不是专业的程序员，我也没有太固定的coding style，只是最近在写一个utility，有些许感想，加上在之前网上收集了一些参考资料，遂想整理出来，以享需要之同志。
* z4 F  ~  I* \1 D, n8 m0 F2 |7 r  K, t这个系列暂时还没想好写多少，目前有以下几个议题，在此基础上展开来写：

• 脚本流程的开发与建立（本文）
  , r2 f8 [% t, E% ]: O' E
• 降低维护成本需要的好习惯
  
• 权衡流程自动化与深入学习之间的矛盾
  

5 C9 C* d# B1 `" ]& a* i8 G* K, Q# ^今天开始将第一个议题：流程的开发与建立
7 D! ?$ H2 S- f3 Q( I$ |

flow chart

% P) k5 k6 G; h- M+ T7 V2 y( u
+ n+ G; b. S: T5 N我是做IC的，大规模集成电路，在我们行业里，一切按流程办事早已成为一种共识，主要是因为集成电路的生产工艺要求很高，生产成本巨大，技术门槛相对较高（专业化），开发周期相对较长（相对传统制造业）。
5 c% Q4 L# Q  b/ F3 [
$ b  R# g* |" k8 o4 b1 p, i
3 F7 k; E- t; W$ REDA工具都有一套行之有效地参考flow，每家公司都会开发一些flow和工具，来提高员工的工作效率，标准化开发手段。那么怎样的flow才是一个好的flow呢？大家的意见都是不同的，我只是管中窥豹地讲下我认为的好flow是怎么样子的。
请看图（原创，如需引用请表明出处）：


5 [. f# l- t* c

• flow是最外层与用户交互的部分，接受用户的输入，给予用户输出结果
  0 H$ i, X9 z' C  R" C- ]) D3 x
• flow与核心的工具没有关系，flow行驶的是管理和后勤之类的事情，而真正生产线上是生产汽车还是生产iphone，这对于flow来说没有差别
  & U6 X# n) f! K/ k4 m) U
• flow中应该要包含项目管理和时间控制等等子模块，这些子模块本身可能也是一个比较复杂的过程
  
• 确定执行具体功能脚本的机制，尽可能降低维护成本
  * S4 V) j4 N8 ~% ~& c9 N! S

$ G/ ^2 E$ C; ?) z7 `4 s5 v2 F对于Tcl来做flow controller，以下两种方式的调用子功能的方法做个比较:
— proc 实现子功能

• 作用域不明确，需要不断切换，EDA工具的所有配置都是在global domain里的，proc封装之后经常会发生作用域不明确，给开发带来额外的负担
  4 D  E+ O. _3 U9 j, A
• 方便管理，责任明确
  & [5 D/ v: n' L8 I( I
• 更新维护方便
  " s2 B, I  a5 ]
• 复用性强
  

) }; Q5 a6 v3 w1 f5 Z8 O# T* |— eval 运行子功能模块
6 ?3 Y/ [3 h: M

• 运行排错滞后，不能在source的时候就发现一些code上的基本错误
  
• 所有功能模块都是在global域内执行的，功能模块中使用到的变量的作用域被扩大
  - s% p: z5 Z; b3 Z1 @
• 开发调试上的便利
  + o/ Y, S% Z) a& e
• 可复用
  
• 使用wrapper的方式运行具体脚本，便于流程的建立
  4 n% N( D- K7 R8 ?; E

由于eval的第三条，我采用的是eval来运行具体的功能模块，相当于给具体的脚本加了一层wrapper，可以做到flow与具体功能脚本隔绝开来，能更好地对flow之外的过程进行详细的控制。
对于方便管理和责任明确，维护方便等优点，我自建了一套debug系统，自己建立数据联系，将脚本管理，维护方式，错误报告等统一起来。
而复用这个问题上，eval的确没有proc来得强，也不可能做到封装，而灵活性本来就是eval的优点，这个要有所取舍了。
我编写的这个flower cotrolloer有如下特性：

7 I  A5 U& w% m1 X1 q
• 读取excel做为配置文件，实则是转换为ASICII文件后做为flow cotroller的配置文件；
  7 H4 Y$ x. I8 C! y# u+ k
• 每个子功能模块需要的信息都定义在配置文件中，包括维护者，各种特性，有flow cotroller读取并存储在变量里；
  
• 有自己的message system，定义多种message的级别；
  ! T+ O2 |, I3 @( w# L
• 输入信息的总体check，有不合理的return并给出解决办法；
  
• 每个子功能模块有tag机制，方便扩展后续功能；
  
• 子模块出错，自动发送mail给维护者，抄送当前用户并记录出错时的error message和所有相关变量的值
  
• 监控子模块的运行时间runtime
  
• flow run结束有mail提醒，mail中有概要的运行结果信息
  , x! b, }/ C0 g" Q1 A# Z
• 最终结果以网页的形式发布
  
• 使用list来代替bool输入
  
• 适用于ICC/EDI并可以支持其他工具
  
• 预留了prerun和postrun的接口
  9 @* {7 G/ d" D- v
• 各种模式切换的接口
  

1 y. ^' @) ~& c, u这些事主要功能，还有很多贴心的小地方在用户的不断测试中在完善。
分享一个Tcl运行cmd set的wrapper ：整套cmd set包含exeCmdSet, msgCmdSet, cfgCmdSet三个命令和一个全局数组变量varCmdSet。

2 N9 z/ Z2 D- E; f' w/ }. _
• 可接受数据输入
  
• 计算runtime
  + J( Q) Z/ E- g, R& y/ g
• mute消息
  
• 自定义array
  , W! v# `+ }8 t: x

?Download execmdset.proc
! F" a3 i7 c* T1 U8 V

' k8 j" ^7 J  R4 j1 U
• proc exeCmdSet {args} {
  
  1 o. U5 n2 s$ I! C0 T
• 
  
  
• global varCmdSet ;
  
  
• my_parse_proc_arguments -args $args alist ;
  . g% C( i% ]2 c
  
• ...
  
  # i' B, B. C( j+ i
• }
  
  % a* M9 y5 T. q" ?+ }3 ^
• my_define_proc_arguments exeCmdSet -info "Evaluate tasks defined in -array, default is strCmdSet" \
  8 V, d& ^7 E- d7 a6 |
  . e- Q, J5 j; I  e
• -define_args {
  . v) I$ J& U& v: e, n
  + M0 n5 q/ P: R4 @) {7 e) \9 G, [6 \
• {task     "Name of tasks" tasks list required}
  / d% T4 D3 K- q0 e( f$ N
  
• {-nomsg   "Boolean to control the stdout msg" "" boolean optional}
  % A6 K7 m  |5 X
  
• {-array   "Array to exec" array string optional}
  / P* f% R* Z# C8 a4 o, x& ]# c9 X
  " H2 H% d7 u" b+ s/ ~9 w. x# ~2 M
• {-runtime "Calculate the runtime" "" boolean optional}
  
  0 j# q6 E: w8 i% P$ x5 T, X
• {-data    "Data store in varCmdSet" data list optional}
  
  
• }
  

复制代码