JavaScript 创建可维护的脚本

查看幻灯片效果

显然，效果很实用。对于这个效果，我们并不解释如何去使用效果库，而是讲解如何创建类似的效果，并保持他的可用性，分离式（unobtrusive），可维护性（让未来的维护者，在不需要修改你的脚本的情况下，修改图片，外观或文本标签）。

无 JavaScript 状态下，用户将看到下面的效果：

• 
• 
• 

添加和移除图片、改变图片的顺序以及添加标题，这些在 HTML 中都很容易做到。并且最后的解决并不意味着维护者需要懂任何 JavaScript 或者在源码中搜索在哪里修改 CSS 的 class, id 或者文本标签。

你有没有准备好花费一些时间去一步一步的尝试创建这个效果？

 

第一步：分析问题（Analizing the problem）

 

创建一个好的脚本，第一步应该是去分析哪些是你要完成的：我们想要创建一个照片的幻灯片效果，并且我们想要保持维护的方便。

 

如何创建一个幻灯片效果

在一个网站上拥有幻灯片有几种方法：

1. 在文档中包含所有的图片。
   当他运行在无 JavaScript 状态，这是一个安全的选择。而且，当页面被载完，所有的图片也会将被载完。然而，这个方式只适用于少量的图片。
2. 在文档中包含第一张图片，并且有一个创建幻灯片功能的服务器端脚本。
   这也是相当安全的，但是对于终端用户来说，这是非常令人厌烦的——因为我不想加载整个页面，仅想得到下一张照片。但对页面展示和广告点击比较有效，这也是为什么大量的新闻站点使用这个方法。
3. 在文档中包含第一张图片，并按需加载其他图片。
   这个方法令你厌烦的是，必须依赖于 JavaScript ，并且要有一个维护照片列表的 JavaScript 数组。你还需提供一个加载指示器，用来显示用户一些正在发生的事情。

在我们的案例中，我们采取下面的图片列表，用向前和向后的按钮把他变成一个幻灯片效果，并且一个指示器告诉我们，照片总数中的哪张照片是当前显示的。

 

1. <ul id="slideshow">
2.     <li><img src="img/flat1.jpg" alt="Hallway" /></li>
3.     <li><img src="img/flat2.jpg" alt="Hob" /></li>
4.     <li><img src="img/flat3.jpg" alt="Bathroom" /></li>
5.     <li><img src="img/flat4.jpg" alt="Living Room" /></li>
6.     <li><img src="img/flat5.jpg" alt="Bedroom" /></li>
7. </ul>

最后的输出会看起来像例子中的幻灯片效果。

 

依赖关系检查

我们这里有一些元素依赖于 JavaScript 生成：文字指示器和向前和向下的链接。为了保持我们解决方法的可用性，我们需要确保一些事情：

1. 仅当 JavaScript 可用（用户信赖我们提供给他们使用的功能）时，这些元素应该出现。一个链接，不能做任何违反用户对我们的信任的事情。
2. 不论输入设备（让我们不要依赖用户是否有鼠标），交互式元素都应该可用。
3. 图片不应该被隐藏，除非使用者能再次访问他们。在技术上，仅显示第一张图片，且没有向前和向后的链接是预留退路的做法，但是为什么要用户已下载所有的图片仅只看到第一张？

第二步：规划脚本（Planning the Script）

 

一旦你已经评估了问题，并挑选出你想使用的解决方法，你便可以开始规划脚本。本质上，我们的脚本应该做这些：

• 检查幻灯片列表是否存在，并且包含一些图片（有理由为一张图片创建一个幻灯片效果吗？）。
• 隐藏所有的照片，但不是第一个。
• 创建向前和向后的链接，和一个显示我们在哪的指示器。
• 添加事件处理程序，使链接增加或减少当前显示的图片编号。
• 确保幻灯片效果没有超出范围，当图片编号小于 0 ，他应该变为最后一张图片，反过来类似。

不同的功能处理

我们有一些方法处理这个问题。其中之一是使用 DOM 遍历每个 LI 条目并隐藏他。在这个事件监听函数，我们先隐藏先前显示的 LI （如果有的话），并显示当前的这个。

注：显示和隐藏代替图片的 LI 更有意义，因为他允许维护者在每个幻灯片上添加其他的元素，比如，一些标题。

这个方法的问题在于，我们在 JavaScript 中做必要的样式改变，这意味着如果有需要比刚才我们脚本中改变 display 从 block 到 none 更复杂的样式改变，将使脚本变得更杂乱（没有从行为中分离表现）。

 

样式留给 CSS 解析器

更简洁的方法是将所有的外观改变（在所有列表项下载完之后隐藏某些）都留给浏览器的 CSS 解析器。在我们的例子中，我们可以在幻灯片中使用一个 CSS 规则很容易地隐藏所有的列表项，并用一个特定的 class 重写当前条目的样式。

HTML：

 

1. <ul id="slideshow">
2.     <li><img src="img/flat1.jpg" alt="Hallway" /></li>
3.     <li><img src="img/flat2.jpg" alt="Hob" /></li>
4.     <li><img src="img/flat3.jpg" alt="Bathroom" /></li>
5.     <li><img src="img/flat4.jpg" alt="Living Room" /></li>
6.     <li><img src="img/flat5.jpg" alt="Bedroom" /></li>
7. </ul>

CSS：

 

1. #slideshow li{
2.     display:none;
3. }
4. #slideshow li.current{
5.     display:block;
6. }

唯一的问题是，如果我们使 CSS 和 JavaScript 不可用，访客将永远不能访问到其他图片。因此，我们需要仅当 JavaScript 可用时，应用这些样式。技巧是，当 JavaScript 可用，在幻灯片的 UL 上应用 class ，例如名为 js 。这允许我们仅当 JavaScript 可用时，显示效果，通过在 CSS 中简单的修改：

CSS：

 

1. #slideshow.js li{
2.     display:none;
3. }
4. #slideshow.js li.current{
5.     display:block;
6. }

这个 class 的钩子（hook）也能被用来对幻灯片的静态和动态版本提供一个完全不同的外观。

我们所有的脚本需要做的是，通过移除或添加 current 的 class 来显示和隐藏当前及以前的照片。

为了确保我们的脚本将不会影响同一页面上的其他脚本，我们将创建一个主要的对象，并在其上构造所有的方法和属性。这可以确保我们的 init() 函数将不会被覆盖或覆盖其他任何相同名字的函数。

JavaScript:：

 

 

1. slideshow = {
2.     current:0, // 当前幻灯片编码
3.     init:function(){
4.         // 初始化和设置事件处理函数
5.     },
6.     show:function(e){
7.         // 事件监听器
8.     }
9. }

第三步、基本的工具方法（ Essential Tools）

 

现在，我们有了规划和建立我们脚本的框架。是时候思考我们需要完成这个功能的一些工具方法。在其最低要求的情况下，DOM 脚本的帮助库应该包括：

• 一个注册事件处理函数的方法，我们目前将使用 John Resig 的 addEvent() 方法。
• 添加和移除 CSS 样式名的方法。
• 一个覆盖 HTML 元素默认行为的方法。我们不希望出现链接的目标页，而仅是执行脚本。

我们添加这些工具方法到主要的对象上，并准备开始：

JavaScript：

1. slideshow = {
2.     current:0, // 当前幻灯片编码
3.     init:function(){
4.         // 初始化和设置事件处理函数
5.     },
6.     show:function(e){
7.         // 事件监听器
8.     },
9.     addEvent:function( obj, type, fn ) {
10.         if ( obj.attachEvent ) {
11.             obj['e'+type+fn] = fn;
12.             obj[type+fn] = function(){
13.                 obj['e'+type+fn]( window.event );
14.             }
15.             obj.attachEvent(’on’+type, obj[type+fn] );
16.         } else
17.             obj.addEventListener( type, fn, false );
18.     },
19.     removeClass:function(o,c){
20.         var rep=o.className.match(’ ‘+c)?’ ‘+c:c;
21.         o.className=o.className.replace(rep,”);
22.     },
23.     addClass:function(o,c){
24.         var test = new RegExp(”(^|//s)”+c+”(//s|$)”).test(o.className);
25.         if(!test){o.className+=o.className?’ ‘+c:c;}
26.     },
27.     cancelClick:function(e){
28.         if (window.event){
29.             window.event.cancelBubble = true;
30.             window.event.returnValue = false;
31.         }
32.         if (e && e.stopPropagation && e.preventDefault){
33.             e.stopPropagation();
34.             e.preventDefault();
35.         }
36.     }
37. }

当文档完全载完，第一件事情就是需要执行 init() 方法：

JavaScript：

 

 

2. slideshow = {
3.     current:0, // 当前幻灯片编码
4.     init:function(){
5.         // 初始化和设置事件处理函数
6.     },
7.     show:function(e){
8.         // 事件监听器
9.     },
10.     addEvent:function( obj, type, fn ) {
11.         if ( obj.attachEvent ) {
12.             obj['e'+type+fn] = fn;
13.             obj[type+fn] = function(){
14.                 obj['e'+type+fn]( window.event );
15.             }
16.             obj.attachEvent(’on’+type, obj[type+fn] );
17.         } else
18.             obj.addEventListener( type, fn, false );
19.     },
20.     removeClass:function(o,c){
21.         var rep=o.className.match(’ ‘+c)?’ ‘+c:c;
22.         o.className=o.className.replace(rep,”);
23.     },
24.     addClass:function(o,c){
25.         var test = new RegExp(”(^|//s)”+c+”(//s|$)”).test(o.className);
26.         if(!test){o.className+=o.className?’ ‘+c:c;}
27.     },
28.     cancelClick:function(e){
29.         if (window.event){
30.             window.event.cancelBubble = true;
31.             window.event.returnValue = false;
32.         }
33.         if (e && e.stopPropagation && e.preventDefault){
34.             e.stopPropagation();
35.             e.preventDefault();
36.         }
37.     }
38. }
42. slideshow.addEvent(window,’load’,slideshow.init);

第四步：脚本（The Script）

 

现在，在适当的位置我们有所有的方法工具，以及当窗口载完时被调用的 init() ，我们可以开始具体化此方法。

注：这仅是 init() 方法，而不是整个脚本。因为有行号，复制并粘贴脚本将会导致错误。

1. 1.  1: init:function(){
   2.  2:     if(document.getElementById && document.createTextNode){
   3.  3:         var list = document.getElementById(' ');
   4.  4:         if(list){
   5.  5:             slideshow.items = list.getElementsByTagName('li');
   6.  6:             slideshow.all = slideshow.items.length;
   7.  7:             if(slideshow.all > 1){
   8.  8:                 slideshow.addClass(list, 'js');
   9.  9:                 slideshow.createNav(list);
   10. 10:            }
   11. 11:         }
   12. 12:         slideshow.show();
   13. 13:     }
   14. 14: },
2. 第2行，检测 DOM 是否被支持。
3. 第3和4行，尝试检索 ID 为 slideshow 的元素，如果没有被定义则不执行余下的方法。
4. 第5和6行，检索列表项及列表项的个数，并分别储存在属性 items 和 all 里。
5. 第7行，检测是否超多一个列表项，如果不超多则不执行余下的。
6. 第8行，添加 js 样式类名到列表上，从而隐藏列表项和应该不同的样式。
7. 第9行，调用 createNav()，并提供这个列表作为参数。
8. 第12行，调用 show() 用来显示预定义了 current 属性的滑动门。

createNav() 方法使用 DOM 脚本创建幻灯片正常工作所需的 HTML。

1. 1. 1: createNav:function(o){
   2.  2:     var p = document.createElement('p');
   3.  3:     slideshow.addClass(p, 'slidenav');
   4.  4:     slideshow.prev = document.createElement('a');
   5.  5:     slideshow.prev.setAttribute('href', '#');
   6.  6:     var templabel = document.createTextNode('<<');
   7.  7:     slideshow.prev.appendChild(templabel);
   8.  8:     slideshow.addEvent(slideshow.prev, 'click', slideshow.show);
   9.  9:     p.appendChild(slideshow.prev);
   10. 10:     slideshow.count = document.createElement('span');
   11. 11:     templabel = document.createTextNode( (slideshow.current+1) + ' / ' + slideshow.all);
   12. 12:     slideshow.count.appendChild(templabel);
   13. 13:     p.appendChild(slideshow.count);
   14. 14:     slideshow.next = document.createElement('a');
   15. 15:     slideshow.next.setAttribute('href', '#');
   16. 16:     var templabel = document.createTextNode('>>’);
   17. 17:     slideshow.next.appendChild(templabel);
   18. 18:     slideshow.addEvent(slideshow.next, ‘click’, slideshow.show);
   19. 19:     p.appendChild(slideshow.next);
   20. 20:     o.parentNode.insertBefore(p, o);
   21. 21: },
2. 第2和3行，刚开始创建一个 P 元素，用来包含整个幻灯片导航，并应用一个名为 slidenav 的 class。
3. 第4和5行，创建一个新的链接元素，储存在叫 prev 的属性中，设置 href 属性为 #。使链接显示为一个真正的链接且键盘可用，是有必要的。
4. 第6行，创建一个新的文本标签。
5. 第7行，将文本标签添加到链接上。
6. 第8行，添加一个事件处理函数，指向 show() 监听方法。
7. 第9行，将新的链接添加到 段落上。
8. 第10行，开始计数器，我们创建一个 SPAN 元素，并用 count 属性储存他。
9. 第11行，创建一个新的文本节点，显示当前幻灯片在总数中的位置。我们需要给当前的属性增加 1，因为人类计数是从 1 开始而非从 0。
10. 第12行，将文本作为新的子节点，添加至 SPAN 上 。
11. 第13行，将 SPAN 元素 添加到段落上。
12. 第14至19行，基本上是复制 4 到 9 行，这次重新创建链接唯一不同的是文本标签，他储存在 next 属性上。
13. 第20行，将最近创建的段落插入到文档中初始的图片列表前。

这些被创建的所有标记都是必要的，最后剩下的是去定义一个当链接被点击时调用的监听方法 show() 。

1. 1.  1: show:function(e){
   2.  2:     if(this === slideshow.next || this === slideshow.prev){
   3.  3:         slideshow.removeClass(slideshow.items[slideshow.current], ‘current’);
   4.  4:         var addto = (this === slideshow.next) ? 1 : -1;
   5.  5:         slideshow.current = slideshow.current + addto;
   6.  6:         if(slideshow.current < 0){
   7.  7:             slideshow.current = (slideshow.all-1);
   8.  8:         }
   9.  9:         if(slideshow.current > slideshow.all-1){
   10. 10:             slideshow.current = 0;
   11. 11:         }
   12. 12:     }
   13. 13:     var templabel = document.createTextNode((slideshow.current+1) + ‘ / ‘ + slideshow.all);
   14. 14:     slideshow.count.replaceChild(templabel, slideshow.count.firstChild);
   15. 15:     slideshow.addClass(slideshow.items[slideshow.current], ‘current’);
   16. 16:     slideshow.cancelClick(e);
   17. 17: },
2. 第1行，得到作为参数 e 的当前事件对象，这是稍后调用的 cancelClick() 唯一需要。
3. 第2行，检测点击的元素是否是向下或者向前链接（this 由 addEvent() 返回）。
4. 第3行，从当前显示的幻灯片上移除 current 的 class。由于现在有一个被点击的链接，这将成为可能。
5. 第4行，通过比较 this 和 next 属性，决定 current 的计数器是应该增加还是减少。
6. 第5行，修正计数器。
7. 第6到11行，确定计数器将永远不会超出范围，当你在第一幻灯片并点击了向前的链接，将设置他为最后一个，而当你在最后一个幻灯片，点击了向后的链接，将设置为第一个。
8. 第13和14行，生成一个新的计数器文本并替代旧的。
9. 第15行，通过设置名为 current 的 class，显示新的当前幻灯片。
10. 第16行，通过调用 cancelClick() 阻止链接的默认行为。

这些是脚本的所有内容。现在这个脚本可以工作，但仍不是真正可维护的。

 

第五步：轻松维护（Easing Maintenance）

 

脚本功能齐全，分离式而且无懈可击。真正的问题是，现在并不方便维护。

脚本应用的最大的问题大概是，并不是所有的维护者都懂 JavaScript 和愿意在你的脚本中寻找需要修改的部分。

为了避免维护者做这些，最安全的方法就是把脚本和 CSS 中使用的命名和 ID 从你的脚本功能中分离出来。此外，从使用的脚本中分离出文本标签也是个好点子，因为他们可能会改变。例如，当脚本使用其他语言本地化时。

 

工具方法的复用

第一件要做的事情就是，从主要脚本中分离出其他脚本也可以再用的工具函数。这也许是大部分 JavaScript 库的开始。

tools.js：

 

1. /* 辅助方法 */
2. tools = {
3.     addEvent:function( obj, type, fn ) {
4.         if ( obj.attachEvent ) {
5.             obj['e'+type+fn] = fn;
6.             obj[type+fn] = function(){
7.                 obj['e'+type+fn]( window.event );
8.             }
9.             obj.attachEvent( ‘on’+type, obj[type+fn] );
10.         } else
11.             obj.addEventListener( type, fn, false );
12.         },
13.     removeClass:function(o,c){
14.         var rep=o.className.match(’ ‘+c)?’ ‘+c:c;
15.         o.className=o.className.replace(rep,”);
16.     },
17.     addClass:function(o,c){
18.         var test = new RegExp(”(^|//s)” + c + “(//s|$)”).test(o.className);
19.         if(!test){o.className+=o.className?’ ‘+c:c;}
20.     },
21.     cancelClick:function(e){
22.         if (window.event){
23.             window.event.cancelBubble = true;
24.             window.event.returnValue = false;
25.         }
26.         if (e && e.stopPropagation && e.preventDefault){
27.             e.stopPropagation();
28.             e.preventDefault();
29.         }
30.     }
31. }

CSS 的 class 和 ID —— 外观

下一步要做的是，分离外观的 class 和 ID 到一个单独的包含文件。保证他们在 slideshow 命名空间里是安全的，因为其他脚本不太可能用到他们。也不会妨碍写一个简短的说明注释。

slideshow-css.js：

 

1. slideshow.css = {
2.     /*
3.     这些都是幻灯片效果中使用到的 classe 和 ID。
4.     你可以在这里修改他们中的任何一个。
5.     务必请使用引号包围名称，用逗号结尾（除了最后一个）。
6.     */
8.     showID               :'slideshow',
9.     dynamicClass         :'js',
10.     slideNavigationClass :'slidenav',
11.     currentClass         :'current'
12. }

文本标签（Text labels）—— 解释给终端用户

最后但不是最不重要的，让我们将文本标签放到一个单独的包含文件，再次使用 slideshow 命名空间。

slideshow-labels.js：

 

1. slideshow.labels = {
2.     /*
3.     这些都是幻灯片效果中使用到文本标签。
4.     你可以在这里修改他们中的任何一个。
5.     务必请使用引号包围名称。
6.     最后一个结尾不用逗号。
7.     */
9.     previous       : '<<',
10.     next           : '>>’,
11.     counterDivider : ‘ of ‘
12. }

改变的主要脚本

然后，我们需要修改主要脚本使用此信息，而不是依赖嵌入式的数据。没有太多的改变，很容易用搜索加替换就能做到。

slideshow.js：

 

1. slideshow = {
2.     current:0,
3.     init:function(){
4.         if(document.getElementById && document.createTextNode){
5.             var list =document.getElementById(slideshow.css.showID);
6.             if(list){
7.                 slideshow.items = list.getElementsByTagName('li');
8.                 slideshow.all = slideshow.items.length;
9.                 if(slideshow.all > 1){
10.                     tools.addClass(list, slideshow.css.dynamicClass);
11.                     slideshow.createNav(list);
12.                 }
13.             }
14.             slideshow.show();
15.         }
16.      },
19.     createNav:function(o){
20.         var p = document.createElement('p');
21.         tools.addClass(p, slideshow.css.slideNavigationClass);
22.         slideshow.prev = document.createElement('a');
23.         slideshow.prev.setAttribute('href', '#');
24.         var templabel = document.createTextNode(slideshow.labels.previous);
25.         slideshow.prev.appendChild(templabel);
26.         tools.addEvent(slideshow.prev, 'click', slideshow.show);
27.         p.appendChild(slideshow.prev);
28.         slideshow.count = document.createElement('span');
29.         templabel =document.createTextNode((slideshow.current+1) + slideshow.labels.counterDivider + slideshow.all);
30.         slideshow.count.appendChild(templabel);
31.         p.appendChild(slideshow.count);
32.         slideshow.next = document.createElement('a');
33.         slideshow.next.setAttribute('href', '#');
34.         var templabel = document.createTextNode(
35.         slideshow.labels.next);
36.         slideshow.next.appendChild(templabel);
37.         tools.addEvent(slideshow.next, 'click', slideshow.show);
38.         p.appendChild(slideshow.next);
39.         o.parentNode.insertBefore(p, o);
40.     },
43.     show:function(e){
44.         if(this === slideshow.next || this === slideshow.prev){
45.             tools.removeClass(slideshow.items[slideshow.current],
46.             slideshow.css.currentClass);
47.             var addto = this === slideshow.next ? 1 : -1;
48.             slideshow.current = slideshow.current + addto;
49.             if(slideshow.current < 0){
50.                 slideshow.current = (slideshow.all-1);
51.             }
52.             if(slideshow.current > slideshow.all-1){
53.                 slideshow.current = 0;
54.             }
55.         }
56.         var templabel = document.createTextNode((slideshow.current+1) + slideshow.labels.counterDivider + slideshow.all);
57.         slideshow.count.replaceChild(templabel, slideshow.count.firstChild);
58.         tools.addClass(slideshow.items[slideshow.current], slideshow.css.currentClass);
59.         tools.cancelClick(e);
60.     }
61. }
64. tools.addEvent(window,’load’,slideshow.init);

这些所有文件是确保将来维护者不用麻烦你就可以使用你的脚本工作所需要的。文件名应该很明显，是什么就是什么，并能随着时间的推移，成为一个标准的脚本：

tools.js
slideshow.js
slideshow-labels.js
slideshow-css.js
slideshow.css

 

原作者：Christian Heilmann 　　译者：怿飞

原文：《A detailed explanation how to create a maintainable dynamic slide show in JavaScript》

译文链接：http://www.blueidea.com/tech/web/2008/5895.asp　

本文链接：http://blog.csdn.net/Larsson/archive/2009/01/09/3742542.aspx