设计模式(11)[JS版]-JavaScript中的注解之装饰器模式

目录

1 什么是装饰器模式?

2 装饰器模式的主要参与者有哪些

3 代码实现

4 实例应用

5 ES7 中的 decorator

6 总结


1 什么是装饰器模式?

装饰器模式模式动态地扩展了(装饰)一个对象的行为,同时又不改变其结构。在运行时添加新的行为的能力是由一个装饰器对象来完成的,它 "包裹 "了原始对象,用来提供额外的功能。多个装饰器可以添加或覆盖原始对象的功能。装饰器模式属于结构型模式。和适配器模式不同的是,适配器模式是原有的对象不能用了,而装饰器模式是原来的对象还能用,在不改变原有对象结构和功能的前提下,为对象添加新功能。

装饰器的一个例子是安全管理,其中业务对象被赋予了额外的访问权限,这取决于经过认证的用户的权限。例如,人力资源经理得到一个雇员对象,该对象已经附加(即装饰了)查看雇员的工资记录权限,这样该员工就可以查看工资信息了。装饰器通过允许运行时更改,为静态类型的语言提供灵活性。但是,JavaScript是一种动态语言,并且在运行时扩展对象的能力已融入该语言本身。

2 装饰器模式的主要参与者有哪些


参与该模式的对象有:

客户端(Client) :维护一个对被装饰的组件的引用。
       组件(Component) :添加了附加功能的对象。
       装饰器(Decorator) :
          1.通过保持对Component的引用来 "包装 "它。
          2. 定义了一个符合Component接口的接口。
          3.实现附加功能(图中addedMembers)。

3 代码实现

在下面的代码中,一个User对象被一个DecoratedUser对象装饰(增强),它扩展了User的地址属性。因为原始接口必须保持不变,所以user.name会被分配给this.name。另外,DecoratedUser的say方法隐藏了User的say方法。

这是装饰器模式的经典实现,但是JavaScript本身的一些语法,就可以更有效的在运行时扩展对象,所以在实际开发中我们一般不会用到这种方法。日志函数用来记录和显示结果。


  
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>装饰器模式:公众号AlbertYang</title>
  6. </head>
  7. <body>
  8. </body>
  9. <script>
  10. var User = function(name) {
  11. this.name = name;
  12. this.say = function() {
  13. log.add("我是" + this.name);
  14. };
  15. }
  16. var DecoratedUser = function(user, city, street) {
  17. this.user = user;
  18. this.name = user.name; // 确保接口保持不变
  19. this.city = city;
  20. this.street = street;
  21. this.say = function() {
  22. log.add("我是" + this.name + ", 住在" + this.city + ", " +
  23. this.street);
  24. };
  25. }
  26. // 日志函数
  27. var log = (function() {
  28. var log = "";
  29. return {
  30. add: function(msg) {
  31. log += msg + "\n";
  32. },
  33. show: function() {
  34. console.info("%c%s", "color:red; font-size:18px", log);
  35. log = "";
  36. }
  37. }
  38. })();
  39. function run() {
  40. var user = new User("张三");
  41. user.say();
  42. var decorated = new DecoratedUser(user, "上海", "宝山路街道");
  43. decorated.say();
  44. log.show();
  45. }
  46. run();
  47. </script>
  48. </html>

4 实例应用


  
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>装饰器模式:公众号AlbertYang</title>
  7. </head>
  8. <body>
  9. <script>
  10. //实例1 - 多重onload绑定
  11. function addLoadEvent(fn) {
  12. var oldEvent = window.onload;
  13. if (typeof window.onload != 'function') {
  14. window.onload = fn;
  15. } else {
  16. window.onload = function() {
  17. oldEvent();
  18. fn();
  19. };
  20. }
  21. }
  22. function fn1() {
  23. console.log('加载函数1');
  24. }
  25. function fn2() {
  26. console.log('加载函数2');
  27. }
  28. function fn3() {
  29. console.log('加载函数3');
  30. }
  31. addLoadEvent(fn1);
  32. addLoadEvent(fn2);
  33. addLoadEvent(fn3);
  34. //实例2 - 前置/后置处理函数(AOP面向切面编程)
  35. Function.prototype.before = function(beforfunc) {
  36. var self = this;//用来保存调用这个函数的引用,如myFunc调用此函数,则self指向myFunc
  37. var outerArgs = Array.prototype.slice.call(arguments, 1);
  38. return function() {//返回一个函数,相当于一个代理函数,也就是说,这里包含了原函数和新函数,原函数指的是myFunc,新函数指的是beforfunc
  39. var innerArgs = Array.prototype.slice.call(arguments);
  40. beforfunc.apply(this, innerArgs);//修正this的指向,将this指针指向beforfunc,将myFunc接收的参数传给beforfunc处理。
  41. self.apply(this, outerArgs);//执行原函数
  42. };
  43. };
  44. Function.prototype.after = function(afterfunc) {
  45. var self = this;
  46. var outerArgs = Array.prototype.slice.call(arguments, 1);
  47. return function() {
  48. var innerArgs = Array.prototype.slice.call(arguments);
  49. self.apply(this, outerArgs);
  50. afterfunc.apply(this, innerArgs);
  51. };
  52. };
  53. var func = function(name) {
  54. console.log('我是' + name);
  55. };
  56. var beforefunc = function(age) {
  57. console.log('我' + age + '岁了');
  58. };
  59. var afterfunc = function(gender) {
  60. console.log('我是一个' + gender);
  61. };
  62. var beforeFunc = func.before(beforefunc, '张三');
  63. var afterFunc = func.after(afterfunc, '张三');
  64. beforeFunc('12');
  65. afterFunc('男人');
  66. //实例3 - 计算函数执行用时
  67. function log(func) {
  68. return function(...args) {
  69. const start = Date.now();
  70. let result = func(...args);
  71. const used = Date.now() - start;
  72. console.log(`调用${func.name} (${args})函数用了 ${used} 毫秒。`);
  73. return result;
  74. };
  75. }
  76. function calculate(times) {
  77. let sum = 0;
  78. let i = 1;
  79. while (i < times) {
  80. sum += i;
  81. i++;
  82. }
  83. return sum;
  84. }
  85. runCalculate = log(calculate);
  86. let result = runCalculate(100000);
  87. console.log(result);
  88. </script>
  89. </body>
  90. </html>

5 ES7 中的 decorator

在ES7中提供了一种类似于java注解的语法糖来实现装饰器模式。decorator的实现依赖于ES5的Object.defineProperty方法来进行扩展和封装的。装饰器是一种函数,写法是 @+函数名。在使用它之前需要引入babel模块 transform-decorators-legacy 编译成 ES5 或 ES6。


  
  1. @testable
  2. class MyTestableClass {
  3. // ...
  4. }
  5. function testable(target) {
  6. target.isTestable = true;
  7. }
  8. MyTestableClass.isTestable // true
  9. @decorator
  10. class A {}
  11. // 等同于
  12. class A {}
  13. A = decorator(A) || A;

上面代码中,@testable就是一个装饰器。它修改了MyTestableClass这个类的属性,为它加上了静态属性isTestable。testable函数的参数target是MyTestableClass类本身。装饰器是一个对类进行处理的函数。装饰器函数的第一个参数,就是所要装饰的目标类。

我们来做一个常用的mixins混合装饰器,来把一个类里面属性和方法全部添加到另一个类上


  
  1. function mixins(...list) {
  2. return function (target) {
  3. Object.assign(target.prototype, ...list)
  4. }
  5. }
  6. const Foo = {
  7. foo() { alert('foo') }
  8. }
  9. @mixins(Foo)
  10. class MyClass {}
  11. let obj = new MyClass();
  12. obj.foo() // 'foo'

装饰方法,让某个方法只读,不能修改


  
  1. function readonly(target, name, descriptor){
  2. // descriptor属性描述对象 (Object.defineProperty 会用到)
  3. // descriptor对象原来的值如下
  4. // {
  5. // value: specifiedFunction,
  6. // enumerable: false,
  7. // configurable: true,
  8. // writable: true
  9. // };
  10. descriptor.writable = false;
  11. return descriptor;
  12. }
  13. class Person {
  14. constructor() {
  15. this.first = 'A'
  16. this.last = 'B'
  17. }
  18. @readonly
  19. testname() { return `${this.first} ${this.last}` }
  20. }
  21. var p = new Person()
  22. console.log(p.testname())
  23. p.testname = function () {} // 这里会报错,因为 name 是只读属性

实现一个日志打印装饰器


  
  1. function log(target, name, descriptor) {
  2. var oldValue = descriptor.value;
  3. // name 是修饰的方法名字
  4. descriptor.value = function() {
  5. console.log(`Calling ${name} with`, arguments);
  6. return oldValue.apply(this, arguments);
  7. };
  8. return descriptor;
  9. }
  10. class Math {
  11. @log
  12. add(a, b) {
  13. return a + b;
  14. }
  15. }
  16. const math = new Math();
  17. const result = math.add(2, 4);
  18. console.log('result', result);

在装饰类的时候,一般主要看装饰函数的target(装饰对象)即第一个参数,装饰方法的时候,一般主要看装饰函数的descriptor(描述)即第三个参数。

     ES7 中的 decorator还有很多其他的用法,由于时间有限,在这里就不展开讲了,如果想要了解更多ES7 中的 decorator,可以去系统学习一下,它的实现原理和用法。

        core-decorators.js是一个第三方模块,提供了几个常见的装饰器,通过它可以更好地理解装饰器。

官网文档:https://github.com/jayphelps/core-decorators.js

6 总结

装饰器模式是一种常见的结构型模式,在不改变类或对象本身结构的情况下,在程序的运行期间动态的为类或对象添加功能。与继承相比,装饰者模式是一种更轻便灵活的做法。Decorator 虽然原理非常简单,却可以实现很多实用又方便的功能,现在前端领域很多框架和库都在使用这个特性,像 mobx中@observable、Angular中的大量应用等都证明了其易用性。个人觉得在开发一些框架的时候,尝试加入装饰器可以使代码更简洁和高效,提高代码质量。

今天的学习就到这里,你可以使用今天学习的技巧来改善一下你曾经的代码,如果想继续提高,欢迎关注我,每天学习进步一点点,就是领先的开始。如果觉得本文对你有帮助的话,欢迎点赞,评论,转发!!!

 

文章来源: albertyang.blog.csdn.net,作者:Albert Yang,版权归原作者所有,如需转载,请联系作者。

原文链接:albertyang.blog.csdn.net/article/details/107826099

(完)