home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _c416deb9fe556ad62a9b80e47cd3e075 < prev    next >
Text File  |  2000-03-23  |  19KB  |  548 lines
  1. <HTML>
  2. <HEAD>
  3. <TITLE>perlbot - Bag'o Object Tricks</TITLE>
  4. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  5. <LINK REV="made" HREF="mailto:">
  6. </HEAD>
  7.  
  8. <BODY>
  9. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  10. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  11. <STRONG><P CLASS=block> perlbot - Bag'o Object Tricks</P></STRONG>
  12. </TD></TR>
  13. </TABLE>
  14.  
  15. <A NAME="__index__"></A>
  16. <!-- INDEX BEGIN -->
  17.  
  18. <UL>
  19.  
  20.     <LI><A HREF="#name">NAME</A></LI>
  21.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  22.     <LI><A HREF="#oo scaling tips">OO SCALING TIPS</A></LI>
  23.     <LI><A HREF="#instance variables">INSTANCE VARIABLES</A></LI>
  24.     <LI><A HREF="#scalar instance variables">SCALAR INSTANCE VARIABLES</A></LI>
  25.     <LI><A HREF="#instance variable inheritance">INSTANCE VARIABLE INHERITANCE</A></LI>
  26.     <LI><A HREF="#object relationships">OBJECT RELATIONSHIPS</A></LI>
  27.     <LI><A HREF="#overriding superclass methods">OVERRIDING SUPERCLASS METHODS</A></LI>
  28.     <LI><A HREF="#using relationship with sdbm">USING RELATIONSHIP WITH SDBM</A></LI>
  29.     <LI><A HREF="#thinking of code reuse">THINKING OF CODE REUSE</A></LI>
  30.     <LI><A HREF="#class context and the object">CLASS CONTEXT AND THE OBJECT</A></LI>
  31.     <LI><A HREF="#inheriting a constructor">INHERITING A CONSTRUCTOR</A></LI>
  32.     <LI><A HREF="#delegation">DELEGATION</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>perlbot - Bag'o Object Tricks (the BOT)</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="description">DESCRIPTION</A></H1>
  43. <P>The following collection of tricks and hints is intended to whet curious
  44. appetites about such things as the use of instance variables and the
  45. mechanics of object and class relationships.  The reader is encouraged to
  46. consult relevant textbooks for discussion of Object Oriented definitions and
  47. methodology.  This is not intended as a tutorial for object-oriented
  48. programming or as a comprehensive guide to Perl's object oriented features,
  49. nor should it be construed as a style guide.</P>
  50. <P>The Perl motto still holds:  There's more than one way to do it.</P>
  51. <P>
  52. <HR>
  53. <H1><A NAME="oo scaling tips">OO SCALING TIPS</A></H1>
  54. <OL>
  55. <LI>
  56. Do not attempt to verify the type of $self.  That'll break if the class is
  57. inherited, when the type of $self is valid but its package isn't what you
  58. expect.  See rule 5.
  59. <P></P>
  60. <LI>
  61. If an object-oriented (OO) or indirect-object (IO) syntax was used, then the
  62. object is probably the correct type and there's no need to become paranoid
  63. about it.  Perl isn't a paranoid language anyway.  If people subvert the OO
  64. or IO syntax then they probably know what they're doing and you should let
  65. them do it.  See rule 1.
  66. <P></P>
  67. <LI>
  68. Use the two-argument form of bless().  Let a subclass use your constructor.
  69. See <A HREF="#inheriting a constructor">INHERITING A CONSTRUCTOR</A>.
  70. <P></P>
  71. <LI>
  72. The subclass is allowed to know things about its immediate superclass, the
  73. superclass is allowed to know nothing about a subclass.
  74. <P></P>
  75. <LI>
  76. Don't be trigger happy with inheritance.  A ``using'', ``containing'', or
  77. ``delegation'' relationship (some sort of aggregation, at least) is often more
  78. appropriate.  See <A HREF="#object relationships">OBJECT RELATIONSHIPS</A>, <A HREF="#using relationship with sdbm">USING RELATIONSHIP WITH SDBM</A>,
  79. and <A HREF="#delegation">DELEGATION</A>.
  80. <P></P>
  81. <LI>
  82. The object is the namespace.  Make package globals accessible via the
  83. object.  This will remove the guess work about the symbol's home package.
  84. See <A HREF="#class context and the object">CLASS CONTEXT AND THE OBJECT</A>.
  85. <P></P>
  86. <LI>
  87. IO syntax is certainly less noisy, but it is also prone to ambiguities that
  88. can cause difficult-to-find bugs.  Allow people to use the sure-thing OO
  89. syntax, even if you don't like it.
  90. <P></P>
  91. <LI>
  92. Do not use function-call syntax on a method.  You're going to be bitten
  93. someday.  Someone might move that method into a superclass and your code
  94. will be broken.  On top of that you're feeding the paranoia in rule 2.
  95. <P></P>
  96. <LI>
  97. Don't assume you know the home package of a method.  You're making it
  98. difficult for someone to override that method.  See <A HREF="#thinking of code reuse">THINKING OF CODE REUSE</A>.
  99. <P></P></OL>
  100. <P>
  101. <HR>
  102. <H1><A NAME="instance variables">INSTANCE VARIABLES</A></H1>
  103. <P>An anonymous array or anonymous hash can be used to hold instance
  104. variables.  Named parameters are also demonstrated.</P>
  105. <PRE>
  106.         package Foo;</PRE>
  107. <PRE>
  108.         sub new {
  109.                 my $type = shift;
  110.                 my %params = @_;
  111.                 my $self = {};
  112.                 $self->{'High'} = $params{'High'};
  113.                 $self->{'Low'}  = $params{'Low'};
  114.                 bless $self, $type;
  115.         }</PRE>
  116. <PRE>
  117.         package Bar;</PRE>
  118. <PRE>
  119.         sub new {
  120.                 my $type = shift;
  121.                 my %params = @_;
  122.                 my $self = [];
  123.                 $self->[0] = $params{'Left'};
  124.                 $self->[1] = $params{'Right'};
  125.                 bless $self, $type;
  126.         }</PRE>
  127. <PRE>
  128.         package main;</PRE>
  129. <PRE>
  130.         $a = Foo->new( 'High' => 42, 'Low' => 11 );
  131.         print "High=$a->{'High'}\n";
  132.         print "Low=$a->{'Low'}\n";</PRE>
  133. <PRE>
  134.         $b = Bar->new( 'Left' => 78, 'Right' => 40 );
  135.         print "Left=$b->[0]\n";
  136.         print "Right=$b->[1]\n";</PRE>
  137. <P>
  138. <HR>
  139. <H1><A NAME="scalar instance variables">SCALAR INSTANCE VARIABLES</A></H1>
  140. <P>An anonymous scalar can be used when only one instance variable is needed.</P>
  141. <PRE>
  142.         package Foo;</PRE>
  143. <PRE>
  144.         sub new {
  145.                 my $type = shift;
  146.                 my $self;
  147.                 $self = shift;
  148.                 bless \$self, $type;
  149.         }</PRE>
  150. <PRE>
  151.         package main;</PRE>
  152. <PRE>
  153.         $a = Foo->new( 42 );
  154.         print "a=$$a\n";</PRE>
  155. <P>
  156. <HR>
  157. <H1><A NAME="instance variable inheritance">INSTANCE VARIABLE INHERITANCE</A></H1>
  158. <P>This example demonstrates how one might inherit instance variables from a
  159. superclass for inclusion in the new class.  This requires calling the
  160. superclass's constructor and adding one's own instance variables to the new
  161. object.</P>
  162. <PRE>
  163.         package Bar;</PRE>
  164. <PRE>
  165.         sub new {
  166.                 my $type = shift;
  167.                 my $self = {};
  168.                 $self->{'buz'} = 42;
  169.                 bless $self, $type;
  170.         }</PRE>
  171. <PRE>
  172.         package Foo;
  173.         @ISA = qw( Bar );</PRE>
  174. <PRE>
  175.         sub new {
  176.                 my $type = shift;
  177.                 my $self = Bar->new;
  178.                 $self->{'biz'} = 11;
  179.                 bless $self, $type;
  180.         }</PRE>
  181. <PRE>
  182.         package main;</PRE>
  183. <PRE>
  184.         $a = Foo->new;
  185.         print "buz = ", $a->{'buz'}, "\n";
  186.         print "biz = ", $a->{'biz'}, "\n";</PRE>
  187. <P>
  188. <HR>
  189. <H1><A NAME="object relationships">OBJECT RELATIONSHIPS</A></H1>
  190. <P>The following demonstrates how one might implement ``containing'' and ``using''
  191. relationships between objects.</P>
  192. <PRE>
  193.         package Bar;</PRE>
  194. <PRE>
  195.         sub new {
  196.                 my $type = shift;
  197.                 my $self = {};
  198.                 $self->{'buz'} = 42;
  199.                 bless $self, $type;
  200.         }</PRE>
  201. <PRE>
  202.         package Foo;</PRE>
  203. <PRE>
  204.         sub new {
  205.                 my $type = shift;
  206.                 my $self = {};
  207.                 $self->{'Bar'} = Bar->new;
  208.                 $self->{'biz'} = 11;
  209.                 bless $self, $type;
  210.         }</PRE>
  211. <PRE>
  212.         package main;</PRE>
  213. <PRE>
  214.         $a = Foo->new;
  215.         print "buz = ", $a->{'Bar'}->{'buz'}, "\n";
  216.         print "biz = ", $a->{'biz'}, "\n";</PRE>
  217. <P>
  218. <HR>
  219. <H1><A NAME="overriding superclass methods">OVERRIDING SUPERCLASS METHODS</A></H1>
  220. <P>The following example demonstrates how to override a superclass method and
  221. then call the overridden method.  The <STRONG>SUPER</STRONG> pseudo-class allows the
  222. programmer to call an overridden superclass method without actually knowing
  223. where that method is defined.</P>
  224. <PRE>
  225.         package Buz;
  226.         sub goo { print "here's the goo\n" }</PRE>
  227. <PRE>
  228.         package Bar; @ISA = qw( Buz );
  229.         sub google { print "google here\n" }</PRE>
  230. <PRE>
  231.         package Baz;
  232.         sub mumble { print "mumbling\n" }</PRE>
  233. <PRE>
  234.         package Foo;
  235.         @ISA = qw( Bar Baz );</PRE>
  236. <PRE>
  237.         sub new {
  238.                 my $type = shift;
  239.                 bless [], $type;
  240.         }
  241.         sub grr { print "grumble\n" }
  242.         sub goo {
  243.                 my $self = shift;
  244.                 $self->SUPER::goo();
  245.         }
  246.         sub mumble {
  247.                 my $self = shift;
  248.                 $self->SUPER::mumble();
  249.         }
  250.         sub google {
  251.                 my $self = shift;
  252.                 $self->SUPER::google();
  253.         }</PRE>
  254. <PRE>
  255.         package main;</PRE>
  256. <PRE>
  257.         $foo = Foo->new;
  258.         $foo->mumble;
  259.         $foo->grr;
  260.         $foo->goo;
  261.         $foo->google;</PRE>
  262. <P>
  263. <HR>
  264. <H1><A NAME="using relationship with sdbm">USING RELATIONSHIP WITH SDBM</A></H1>
  265. <P>This example demonstrates an interface for the SDBM class.  This creates a
  266. ``using'' relationship between the SDBM class and the new class Mydbm.</P>
  267. <PRE>
  268.         package Mydbm;</PRE>
  269. <PRE>
  270.         require SDBM_File;
  271.         require Tie::Hash;
  272.         @ISA = qw( Tie::Hash );</PRE>
  273. <PRE>
  274.         sub TIEHASH {
  275.             my $type = shift;
  276.             my $ref  = SDBM_File->new(@_);
  277.             bless {'dbm' => $ref}, $type;
  278.         }
  279.         sub FETCH {
  280.             my $self = shift;
  281.             my $ref  = $self->{'dbm'};
  282.             $ref->FETCH(@_);
  283.         }
  284.         sub STORE {
  285.             my $self = shift;
  286.             if (defined $_[0]){
  287.                 my $ref = $self->{'dbm'};
  288.                 $ref->STORE(@_);
  289.             } else {
  290.                 die "Cannot STORE an undefined key in Mydbm\n";
  291.             }
  292.         }</PRE>
  293. <PRE>
  294.         package main;
  295.         use Fcntl qw( O_RDWR O_CREAT );</PRE>
  296. <PRE>
  297.         tie %foo, "Mydbm", "Sdbm", O_RDWR|O_CREAT, 0640;
  298.         $foo{'bar'} = 123;
  299.         print "foo-bar = $foo{'bar'}\n";</PRE>
  300. <PRE>
  301.         tie %bar, "Mydbm", "Sdbm2", O_RDWR|O_CREAT, 0640;
  302.         $bar{'Cathy'} = 456;
  303.         print "bar-Cathy = $bar{'Cathy'}\n";</PRE>
  304. <P>
  305. <HR>
  306. <H1><A NAME="thinking of code reuse">THINKING OF CODE REUSE</A></H1>
  307. <P>One strength of Object-Oriented languages is the ease with which old code
  308. can use new code.  The following examples will demonstrate first how one can
  309. hinder code reuse and then how one can promote code reuse.</P>
  310. <P>This first example illustrates a class which uses a fully-qualified method
  311. call to access the ``private'' method BAZ().  The second example will show
  312. that it is impossible to override the <CODE>BAZ()</CODE> method.</P>
  313. <PRE>
  314.         package FOO;</PRE>
  315. <PRE>
  316.         sub new {
  317.                 my $type = shift;
  318.                 bless {}, $type;
  319.         }
  320.         sub bar {
  321.                 my $self = shift;
  322.                 $self->FOO::private::BAZ;
  323.         }</PRE>
  324. <PRE>
  325.         package FOO::private;</PRE>
  326. <PRE>
  327.         sub BAZ {
  328.                 print "in BAZ\n";
  329.         }</PRE>
  330. <PRE>
  331.         package main;</PRE>
  332. <PRE>
  333.         $a = FOO->new;
  334.         $a->bar;</PRE>
  335. <P>Now we try to override the <CODE>BAZ()</CODE> method.  We would like FOO::bar() to call
  336. GOOP::BAZ(), but this cannot happen because FOO::bar() explicitly calls
  337. FOO::private::BAZ().</P>
  338. <PRE>
  339.         package FOO;</PRE>
  340. <PRE>
  341.         sub new {
  342.                 my $type = shift;
  343.                 bless {}, $type;
  344.         }
  345.         sub bar {
  346.                 my $self = shift;
  347.                 $self->FOO::private::BAZ;
  348.         }</PRE>
  349. <PRE>
  350.         package FOO::private;</PRE>
  351. <PRE>
  352.         sub BAZ {
  353.                 print "in BAZ\n";
  354.         }</PRE>
  355. <PRE>
  356.         package GOOP;
  357.         @ISA = qw( FOO );
  358.         sub new {
  359.                 my $type = shift;
  360.                 bless {}, $type;
  361.         }</PRE>
  362. <PRE>
  363.         sub BAZ {
  364.                 print "in GOOP::BAZ\n";
  365.         }</PRE>
  366. <PRE>
  367.         package main;</PRE>
  368. <PRE>
  369.         $a = GOOP->new;
  370.         $a->bar;</PRE>
  371. <P>To create reusable code we must modify class FOO, flattening class
  372. FOO::private.  The next example shows a reusable class FOO which allows the
  373. method GOOP::BAZ() to be used in place of FOO::BAZ().</P>
  374. <PRE>
  375.         package FOO;</PRE>
  376. <PRE>
  377.         sub new {
  378.                 my $type = shift;
  379.                 bless {}, $type;
  380.         }
  381.         sub bar {
  382.                 my $self = shift;
  383.                 $self->BAZ;
  384.         }</PRE>
  385. <PRE>
  386.         sub BAZ {
  387.                 print "in BAZ\n";
  388.         }</PRE>
  389. <PRE>
  390.         package GOOP;
  391.         @ISA = qw( FOO );</PRE>
  392. <PRE>
  393.         sub new {
  394.                 my $type = shift;
  395.                 bless {}, $type;
  396.         }
  397.         sub BAZ {
  398.                 print "in GOOP::BAZ\n";
  399.         }</PRE>
  400. <PRE>
  401.         package main;</PRE>
  402. <PRE>
  403.         $a = GOOP->new;
  404.         $a->bar;</PRE>
  405. <P>
  406. <HR>
  407. <H1><A NAME="class context and the object">CLASS CONTEXT AND THE OBJECT</A></H1>
  408. <P>Use the object to solve package and class context problems.  Everything a
  409. method needs should be available via the object or should be passed as a
  410. parameter to the method.</P>
  411. <P>A class will sometimes have static or global data to be used by the
  412. methods.  A subclass may want to override that data and replace it with new
  413. data.  When this happens the superclass may not know how to find the new
  414. copy of the data.</P>
  415. <P>This problem can be solved by using the object to define the context of the
  416. method.  Let the method look in the object for a reference to the data.  The
  417. alternative is to force the method to go hunting for the data (``Is it in my
  418. class, or in a subclass?  Which subclass?''), and this can be inconvenient
  419. and will lead to hackery.  It is better just to let the object tell the
  420. method where that data is located.</P>
  421. <PRE>
  422.         package Bar;</PRE>
  423. <PRE>
  424.         %fizzle = ( 'Password' => 'XYZZY' );</PRE>
  425. <PRE>
  426.         sub new {
  427.                 my $type = shift;
  428.                 my $self = {};
  429.                 $self->{'fizzle'} = \%fizzle;
  430.                 bless $self, $type;
  431.         }</PRE>
  432. <PRE>
  433.         sub enter {
  434.                 my $self = shift;</PRE>
  435. <PRE>
  436.                 # Don't try to guess if we should use %Bar::fizzle
  437.                 # or %Foo::fizzle.  The object already knows which
  438.                 # we should use, so just ask it.
  439.                 #
  440.                 my $fizzle = $self->{'fizzle'};</PRE>
  441. <PRE>
  442.                 print "The word is ", $fizzle->{'Password'}, "\n";
  443.         }</PRE>
  444. <PRE>
  445.         package Foo;
  446.         @ISA = qw( Bar );</PRE>
  447. <PRE>
  448.         %fizzle = ( 'Password' => 'Rumple' );</PRE>
  449. <PRE>
  450.         sub new {
  451.                 my $type = shift;
  452.                 my $self = Bar->new;
  453.                 $self->{'fizzle'} = \%fizzle;
  454.                 bless $self, $type;
  455.         }</PRE>
  456. <PRE>
  457.         package main;</PRE>
  458. <PRE>
  459.         $a = Bar->new;
  460.         $b = Foo->new;
  461.         $a->enter;
  462.         $b->enter;</PRE>
  463. <P>
  464. <HR>
  465. <H1><A NAME="inheriting a constructor">INHERITING A CONSTRUCTOR</A></H1>
  466. <P>An inheritable constructor should use the second form of <A HREF="../../lib/Pod/perlfunc.html#item_bless"><CODE>bless()</CODE></A> which allows
  467. blessing directly into a specified class.  Notice in this example that the
  468. object will be a BAR not a FOO, even though the constructor is in class FOO.</P>
  469. <PRE>
  470.         package FOO;</PRE>
  471. <PRE>
  472.         sub new {
  473.                 my $type = shift;
  474.                 my $self = {};
  475.                 bless $self, $type;
  476.         }</PRE>
  477. <PRE>
  478.         sub baz {
  479.                 print "in FOO::baz()\n";
  480.         }</PRE>
  481. <PRE>
  482.         package BAR;
  483.         @ISA = qw(FOO);</PRE>
  484. <PRE>
  485.         sub baz {
  486.                 print "in BAR::baz()\n";
  487.         }</PRE>
  488. <PRE>
  489.         package main;</PRE>
  490. <PRE>
  491.         $a = BAR->new;
  492.         $a->baz;</PRE>
  493. <P>
  494. <HR>
  495. <H1><A NAME="delegation">DELEGATION</A></H1>
  496. <P>Some classes, such as SDBM_File, cannot be effectively subclassed because
  497. they create foreign objects.  Such a class can be extended with some sort of
  498. aggregation technique such as the ``using'' relationship mentioned earlier or
  499. by delegation.</P>
  500. <P>The following example demonstrates delegation using an <CODE>AUTOLOAD()</CODE> function to
  501. perform message-forwarding.  This will allow the Mydbm object to behave
  502. exactly like an SDBM_File object.  The Mydbm class could now extend the
  503. behavior by adding custom <CODE>FETCH()</CODE> and <CODE>STORE()</CODE> methods, if this is desired.</P>
  504. <PRE>
  505.         package Mydbm;</PRE>
  506. <PRE>
  507.         require SDBM_File;
  508.         require Tie::Hash;
  509.         @ISA = qw(Tie::Hash);</PRE>
  510. <PRE>
  511.         sub TIEHASH {
  512.                 my $type = shift;
  513.                 my $ref = SDBM_File->new(@_);
  514.                 bless {'delegate' => $ref};
  515.         }</PRE>
  516. <PRE>
  517.         sub AUTOLOAD {
  518.                 my $self = shift;</PRE>
  519. <PRE>
  520.                 # The Perl interpreter places the name of the
  521.                 # message in a variable called $AUTOLOAD.</PRE>
  522. <PRE>
  523.                 # DESTROY messages should never be propagated.
  524.                 return if $AUTOLOAD =~ /::DESTROY$/;</PRE>
  525. <PRE>
  526.                 # Remove the package name.
  527.                 $AUTOLOAD =~ s/^Mydbm:://;</PRE>
  528. <PRE>
  529.                 # Pass the message to the delegate.
  530.                 $self->{'delegate'}->$AUTOLOAD(@_);
  531.         }</PRE>
  532. <PRE>
  533.         package main;
  534.         use Fcntl qw( O_RDWR O_CREAT );</PRE>
  535. <PRE>
  536.         tie %foo, "Mydbm", "adbm", O_RDWR|O_CREAT, 0640;
  537.         $foo{'bar'} = 123;
  538.         print "foo-bar = $foo{'bar'}\n";</PRE>
  539. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  540. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  541. <STRONG><P CLASS=block> perlbot - Bag'o Object Tricks</P></STRONG>
  542. </TD></TR>
  543. </TABLE>
  544.  
  545. </BODY>
  546.  
  547. </HTML>
  548.