05-spring-boot-web.html 80KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="Asciidoctor 1.5.5">
  8. <title>Spring Boot Web</title>
  9. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10. <style>
  11. /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12. /* Remove comment around @import statement below when using as a custom stylesheet */
  13. /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14. article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15. audio,canvas,video{display:inline-block}
  16. audio:not([controls]){display:none;height:0}
  17. [hidden],template{display:none}
  18. script{display:none!important}
  19. html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  20. a{background:transparent}
  21. a:focus{outline:thin dotted}
  22. a:active,a:hover{outline:0}
  23. h1{font-size:2em;margin:.67em 0}
  24. abbr[title]{border-bottom:1px dotted}
  25. b,strong{font-weight:bold}
  26. dfn{font-style:italic}
  27. hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  28. mark{background:#ff0;color:#000}
  29. code,kbd,pre,samp{font-family:monospace;font-size:1em}
  30. pre{white-space:pre-wrap}
  31. q{quotes:"\201C" "\201D" "\2018" "\2019"}
  32. small{font-size:80%}
  33. sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  34. sup{top:-.5em}
  35. sub{bottom:-.25em}
  36. img{border:0}
  37. svg:not(:root){overflow:hidden}
  38. figure{margin:0}
  39. fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  40. legend{border:0;padding:0}
  41. button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  42. button,input{line-height:normal}
  43. button,select{text-transform:none}
  44. button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  45. button[disabled],html input[disabled]{cursor:default}
  46. input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  47. input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  48. input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  49. button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  50. textarea{overflow:auto;vertical-align:top}
  51. table{border-collapse:collapse;border-spacing:0}
  52. *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  53. html,body{font-size:100%}
  54. body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  55. a:hover{cursor:pointer}
  56. img,object,embed{max-width:100%;height:auto}
  57. object,embed{height:100%}
  58. img{-ms-interpolation-mode:bicubic}
  59. .left{float:left!important}
  60. .right{float:right!important}
  61. .text-left{text-align:left!important}
  62. .text-right{text-align:right!important}
  63. .text-center{text-align:center!important}
  64. .text-justify{text-align:justify!important}
  65. .hide{display:none}
  66. img,object,svg{display:inline-block;vertical-align:middle}
  67. textarea{height:auto;min-height:50px}
  68. select{width:100%}
  69. .center{margin-left:auto;margin-right:auto}
  70. .spread{width:100%}
  71. p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  72. .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  73. div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  74. a{color:#2156a5;text-decoration:underline;line-height:inherit}
  75. a:hover,a:focus{color:#1d4b8f}
  76. a img{border:none}
  77. p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  78. p aside{font-size:.875em;line-height:1.35;font-style:italic}
  79. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  80. h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  81. h1{font-size:2.125em}
  82. h2{font-size:1.6875em}
  83. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  84. h4,h5{font-size:1.125em}
  85. h6{font-size:1em}
  86. hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  87. em,i{font-style:italic;line-height:inherit}
  88. strong,b{font-weight:bold;line-height:inherit}
  89. small{font-size:60%;line-height:inherit}
  90. code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  91. ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  92. ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
  93. ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  94. ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  95. ul.square{list-style-type:square}
  96. ul.circle{list-style-type:circle}
  97. ul.disc{list-style-type:disc}
  98. ul.no-bullet{list-style:none}
  99. ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  100. dl dt{margin-bottom:.3125em;font-weight:bold}
  101. dl dd{margin-bottom:1.25em}
  102. abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
  103. abbr{text-transform:none}
  104. blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  105. blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
  106. blockquote cite:before{content:"\2014 \0020"}
  107. blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
  108. blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  109. @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  110. h1{font-size:2.75em}
  111. h2{font-size:2.3125em}
  112. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
  113. h4{font-size:1.4375em}}
  114. table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
  115. table thead,table tfoot{background:#f7f8f7;font-weight:bold}
  116. table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
  117. table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
  118. table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
  119. table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
  120. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
  121. h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
  122. .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
  123. .clearfix:after,.float-group:after{clear:both}
  124. *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
  125. *:not(pre)>code.nobreak{word-wrap:normal}
  126. *:not(pre)>code.nowrap{white-space:nowrap}
  127. pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
  128. em em{font-style:normal}
  129. strong strong{font-weight:400}
  130. .keyseq{color:rgba(51,51,51,.8)}
  131. kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
  132. .keyseq kbd:first-child{margin-left:0}
  133. .keyseq kbd:last-child{margin-right:0}
  134. .menuseq,.menu{color:rgba(0,0,0,.8)}
  135. b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
  136. b.button:before{content:"[";padding:0 3px 0 2px}
  137. b.button:after{content:"]";padding:0 2px 0 3px}
  138. p a>code:hover{color:rgba(0,0,0,.9)}
  139. #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
  140. #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
  141. #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
  142. #content{margin-top:1.25em}
  143. #content:before{content:none}
  144. #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
  145. #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
  146. #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
  147. #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
  148. #header .details span:first-child{margin-left:-.125em}
  149. #header .details span.email a{color:rgba(0,0,0,.85)}
  150. #header .details br{display:none}
  151. #header .details br+span:before{content:"\00a0\2013\00a0"}
  152. #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
  153. #header .details br+span#revremark:before{content:"\00a0|\00a0"}
  154. #header #revnumber{text-transform:capitalize}
  155. #header #revnumber:after{content:"\00a0"}
  156. #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
  157. #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
  158. #toc>ul{margin-left:.125em}
  159. #toc ul.sectlevel0>li>a{font-style:italic}
  160. #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
  161. #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
  162. #toc li{line-height:1.3334;margin-top:.3334em}
  163. #toc a{text-decoration:none}
  164. #toc a:active{text-decoration:underline}
  165. #toctitle{color:#7a2518;font-size:1.2em}
  166. @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
  167. body.toc2{padding-left:15em;padding-right:0}
  168. #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
  169. #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
  170. #toc.toc2>ul{font-size:.9em;margin-bottom:0}
  171. #toc.toc2 ul ul{margin-left:0;padding-left:1em}
  172. #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
  173. body.toc2.toc-right{padding-left:0;padding-right:15em}
  174. body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
  175. @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
  176. #toc.toc2{width:20em}
  177. #toc.toc2 #toctitle{font-size:1.375em}
  178. #toc.toc2>ul{font-size:.95em}
  179. #toc.toc2 ul ul{padding-left:1.25em}
  180. body.toc2.toc-right{padding-left:0;padding-right:20em}}
  181. #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
  182. #content #toc>:first-child{margin-top:0}
  183. #content #toc>:last-child{margin-bottom:0}
  184. #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
  185. #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
  186. .sect1{padding-bottom:.625em}
  187. @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
  188. .sect1+.sect1{border-top:1px solid #efefed}
  189. #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
  190. #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
  191. #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
  192. #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
  193. #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
  194. .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
  195. .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
  196. table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
  197. .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
  198. table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
  199. .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
  200. .admonitionblock>table td.icon{text-align:center;width:80px}
  201. .admonitionblock>table td.icon img{max-width:none}
  202. .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
  203. .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
  204. .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
  205. .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
  206. .exampleblock>.content>:first-child{margin-top:0}
  207. .exampleblock>.content>:last-child{margin-bottom:0}
  208. .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
  209. .sidebarblock>:first-child{margin-top:0}
  210. .sidebarblock>:last-child{margin-bottom:0}
  211. .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
  212. .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
  213. .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
  214. .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
  215. .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
  216. .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
  217. @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
  218. @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
  219. .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
  220. .listingblock pre.highlightjs{padding:0}
  221. .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
  222. .listingblock pre.prettyprint{border-width:0}
  223. .listingblock>.content{position:relative}
  224. .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
  225. .listingblock:hover code[data-lang]:before{display:block}
  226. .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
  227. .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
  228. table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
  229. table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
  230. table.pyhltable td.code{padding-left:.75em;padding-right:0}
  231. pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
  232. pre.pygments .lineno{display:inline-block;margin-right:.25em}
  233. table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
  234. .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
  235. .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
  236. .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
  237. .quoteblock blockquote{margin:0;padding:0;border:0}
  238. .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
  239. .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
  240. .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
  241. .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
  242. .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
  243. .quoteblock .quoteblock blockquote:before{display:none}
  244. .verseblock{margin:0 1em 1.25em 1em}
  245. .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
  246. .verseblock pre strong{font-weight:400}
  247. .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
  248. .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
  249. .quoteblock .attribution br,.verseblock .attribution br{display:none}
  250. .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
  251. .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
  252. .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
  253. .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
  254. table.tableblock{max-width:100%;border-collapse:separate}
  255. table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
  256. table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
  257. table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
  258. table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
  259. table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
  260. table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
  261. table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
  262. table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
  263. table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
  264. table.frame-all{border-width:1px}
  265. table.frame-sides{border-width:0 1px}
  266. table.frame-topbot{border-width:1px 0}
  267. th.halign-left,td.halign-left{text-align:left}
  268. th.halign-right,td.halign-right{text-align:right}
  269. th.halign-center,td.halign-center{text-align:center}
  270. th.valign-top,td.valign-top{vertical-align:top}
  271. th.valign-bottom,td.valign-bottom{vertical-align:bottom}
  272. th.valign-middle,td.valign-middle{vertical-align:middle}
  273. table thead th,table tfoot th{font-weight:bold}
  274. tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
  275. tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
  276. p.tableblock>code:only-child{background:none;padding:0}
  277. p.tableblock{font-size:1em}
  278. td>div.verse{white-space:pre}
  279. ol{margin-left:1.75em}
  280. ul li ol{margin-left:1.5em}
  281. dl dd{margin-left:1.125em}
  282. dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
  283. ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
  284. ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
  285. ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
  286. ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
  287. ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
  288. ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
  289. ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
  290. ul.inline>li>*{display:block}
  291. .unstyled dl dt{font-weight:400;font-style:normal}
  292. ol.arabic{list-style-type:decimal}
  293. ol.decimal{list-style-type:decimal-leading-zero}
  294. ol.loweralpha{list-style-type:lower-alpha}
  295. ol.upperalpha{list-style-type:upper-alpha}
  296. ol.lowerroman{list-style-type:lower-roman}
  297. ol.upperroman{list-style-type:upper-roman}
  298. ol.lowergreek{list-style-type:lower-greek}
  299. .hdlist>table,.colist>table{border:0;background:none}
  300. .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
  301. td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
  302. td.hdlist1{font-weight:bold;padding-bottom:1.25em}
  303. .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
  304. .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
  305. .colist>table tr>td:last-of-type{padding:.25em 0}
  306. .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
  307. .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
  308. .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
  309. .imageblock>.title{margin-bottom:0}
  310. .imageblock.thumb,.imageblock.th{border-width:6px}
  311. .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
  312. .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
  313. .image.left{margin-right:.625em}
  314. .image.right{margin-left:.625em}
  315. a.image{text-decoration:none;display:inline-block}
  316. a.image object{pointer-events:none}
  317. sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
  318. sup.footnote a,sup.footnoteref a{text-decoration:none}
  319. sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
  320. #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
  321. #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
  322. #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
  323. #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
  324. #footnotes .footnote:last-of-type{margin-bottom:0}
  325. #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
  326. .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
  327. .gist .file-data>table td.line-data{width:99%}
  328. div.unbreakable{page-break-inside:avoid}
  329. .big{font-size:larger}
  330. .small{font-size:smaller}
  331. .underline{text-decoration:underline}
  332. .overline{text-decoration:overline}
  333. .line-through{text-decoration:line-through}
  334. .aqua{color:#00bfbf}
  335. .aqua-background{background-color:#00fafa}
  336. .black{color:#000}
  337. .black-background{background-color:#000}
  338. .blue{color:#0000bf}
  339. .blue-background{background-color:#0000fa}
  340. .fuchsia{color:#bf00bf}
  341. .fuchsia-background{background-color:#fa00fa}
  342. .gray{color:#606060}
  343. .gray-background{background-color:#7d7d7d}
  344. .green{color:#006000}
  345. .green-background{background-color:#007d00}
  346. .lime{color:#00bf00}
  347. .lime-background{background-color:#00fa00}
  348. .maroon{color:#600000}
  349. .maroon-background{background-color:#7d0000}
  350. .navy{color:#000060}
  351. .navy-background{background-color:#00007d}
  352. .olive{color:#606000}
  353. .olive-background{background-color:#7d7d00}
  354. .purple{color:#600060}
  355. .purple-background{background-color:#7d007d}
  356. .red{color:#bf0000}
  357. .red-background{background-color:#fa0000}
  358. .silver{color:#909090}
  359. .silver-background{background-color:#bcbcbc}
  360. .teal{color:#006060}
  361. .teal-background{background-color:#007d7d}
  362. .white{color:#bfbfbf}
  363. .white-background{background-color:#fafafa}
  364. .yellow{color:#bfbf00}
  365. .yellow-background{background-color:#fafa00}
  366. span.icon>.fa{cursor:default}
  367. .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
  368. .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
  369. .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
  370. .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
  371. .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
  372. .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
  373. .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
  374. .conum[data-value] *{color:#fff!important}
  375. .conum[data-value]+b{display:none}
  376. .conum[data-value]:after{content:attr(data-value)}
  377. pre .conum[data-value]{position:relative;top:-.125em}
  378. b.conum *{color:inherit!important}
  379. .conum:not([data-value]):empty{display:none}
  380. dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
  381. h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
  382. p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
  383. p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
  384. p{margin-bottom:1.25rem}
  385. .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
  386. .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
  387. .print-only{display:none!important}
  388. @media print{@page{margin:1.25cm .75cm}
  389. *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
  390. a{color:inherit!important;text-decoration:underline!important}
  391. a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
  392. a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
  393. abbr[title]:after{content:" (" attr(title) ")"}
  394. pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
  395. thead{display:table-header-group}
  396. svg{max-width:100%}
  397. p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
  398. h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
  399. #toc,.sidebarblock,.exampleblock>.content{background:none!important}
  400. #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
  401. .sect1{padding-bottom:0!important}
  402. .sect1+.sect1{border:0!important}
  403. #header>h1:first-child{margin-top:1.25rem}
  404. body.book #header{text-align:center}
  405. body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
  406. body.book #header .details{border:0!important;display:block;padding:0!important}
  407. body.book #header .details span:first-child{margin-left:0!important}
  408. body.book #header .details br{display:block}
  409. body.book #header .details br+span:before{content:none!important}
  410. body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
  411. body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
  412. .listingblock code[data-lang]:before{display:block}
  413. #footer{background:none!important;padding:0 .9375em}
  414. #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
  415. .hide-on-print{display:none!important}
  416. .print-only{display:block!important}
  417. .hide-for-print{display:none!important}
  418. .show-for-print{display:inherit!important}}
  419. </style>
  420. <style>
  421. /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
  422. /*pre.CodeRay {background-color:#f7f7f8;}*/
  423. .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
  424. .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
  425. .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
  426. table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
  427. table.CodeRay td{vertical-align: top;line-height:1.45}
  428. table.CodeRay td.line-numbers{text-align:right}
  429. table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
  430. table.CodeRay td.code{padding:0 0 0 .5em}
  431. table.CodeRay td.code>pre{padding:0}
  432. .CodeRay .debug{color:#fff !important;background:#000080 !important}
  433. .CodeRay .annotation{color:#007}
  434. .CodeRay .attribute-name{color:#000080}
  435. .CodeRay .attribute-value{color:#700}
  436. .CodeRay .binary{color:#509}
  437. .CodeRay .comment{color:#998;font-style:italic}
  438. .CodeRay .char{color:#04d}
  439. .CodeRay .char .content{color:#04d}
  440. .CodeRay .char .delimiter{color:#039}
  441. .CodeRay .class{color:#458;font-weight:bold}
  442. .CodeRay .complex{color:#a08}
  443. .CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
  444. .CodeRay .color{color:#099}
  445. .CodeRay .class-variable{color:#369}
  446. .CodeRay .decorator{color:#b0b}
  447. .CodeRay .definition{color:#099}
  448. .CodeRay .delimiter{color:#000}
  449. .CodeRay .doc{color:#970}
  450. .CodeRay .doctype{color:#34b}
  451. .CodeRay .doc-string{color:#d42}
  452. .CodeRay .escape{color:#666}
  453. .CodeRay .entity{color:#800}
  454. .CodeRay .error{color:#808}
  455. .CodeRay .exception{color:inherit}
  456. .CodeRay .filename{color:#099}
  457. .CodeRay .function{color:#900;font-weight:bold}
  458. .CodeRay .global-variable{color:#008080}
  459. .CodeRay .hex{color:#058}
  460. .CodeRay .integer,.CodeRay .float{color:#099}
  461. .CodeRay .include{color:#555}
  462. .CodeRay .inline{color:#000}
  463. .CodeRay .inline .inline{background:#ccc}
  464. .CodeRay .inline .inline .inline{background:#bbb}
  465. .CodeRay .inline .inline-delimiter{color:#d14}
  466. .CodeRay .inline-delimiter{color:#d14}
  467. .CodeRay .important{color:#555;font-weight:bold}
  468. .CodeRay .interpreted{color:#b2b}
  469. .CodeRay .instance-variable{color:#008080}
  470. .CodeRay .label{color:#970}
  471. .CodeRay .local-variable{color:#963}
  472. .CodeRay .octal{color:#40e}
  473. .CodeRay .predefined{color:#369}
  474. .CodeRay .preprocessor{color:#579}
  475. .CodeRay .pseudo-class{color:#555}
  476. .CodeRay .directive{font-weight:bold}
  477. .CodeRay .type{font-weight:bold}
  478. .CodeRay .predefined-type{color:inherit}
  479. .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
  480. .CodeRay .key{color:#808}
  481. .CodeRay .key .delimiter{color:#606}
  482. .CodeRay .key .char{color:#80f}
  483. .CodeRay .value{color:#088}
  484. .CodeRay .regexp .delimiter{color:#808}
  485. .CodeRay .regexp .content{color:#808}
  486. .CodeRay .regexp .modifier{color:#808}
  487. .CodeRay .regexp .char{color:#d14}
  488. .CodeRay .regexp .function{color:#404;font-weight:bold}
  489. .CodeRay .string{color:#d20}
  490. .CodeRay .string .string .string{background:#ffd0d0}
  491. .CodeRay .string .content{color:#d14}
  492. .CodeRay .string .char{color:#d14}
  493. .CodeRay .string .delimiter{color:#d14}
  494. .CodeRay .shell{color:#d14}
  495. .CodeRay .shell .delimiter{color:#d14}
  496. .CodeRay .symbol{color:#990073}
  497. .CodeRay .symbol .content{color:#a60}
  498. .CodeRay .symbol .delimiter{color:#630}
  499. .CodeRay .tag{color:#008080}
  500. .CodeRay .tag-special{color:#d70}
  501. .CodeRay .variable{color:#036}
  502. .CodeRay .insert{background:#afa}
  503. .CodeRay .delete{background:#faa}
  504. .CodeRay .change{color:#aaf;background:#007}
  505. .CodeRay .head{color:#f8f;background:#505}
  506. .CodeRay .insert .insert{color:#080}
  507. .CodeRay .delete .delete{color:#800}
  508. .CodeRay .change .change{color:#66f}
  509. .CodeRay .head .head{color:#f4f}
  510. </style>
  511. <link rel="stylesheet"
  512. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
  513. integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"
  514. crossorigin="anonymous">
  515. <link rel="stylesheet"
  516. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
  517. integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp"
  518. crossorigin="anonymous">
  519. <style>
  520. .c2cb{
  521. position: absolute; left: 0; top: 0;
  522. cursor: pointer
  523. }
  524. .c2cb:focus {
  525. outline: none;
  526. }
  527. body {
  528. font-size: 18px;
  529. }
  530. p {
  531. font-size: 18px;
  532. }
  533. td.content {
  534. font-size:2.0625rem;
  535. }
  536. div.title {
  537. font-size:2.0625rem;
  538. }
  539. </style>
  540. <script src="js/jquery-3.2.1.min.js"></script>
  541. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
  542. <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
  543. <script>
  544. $(function() {
  545. var button = $("<div style='padding: 10px;'><button data-toggle='tooltip' placement='right' data-trigger='click' title='Copied!' class='c2cb glyphicon glyphicon-copy'></button></div>");
  546. $(".listingblock > .content pre").prepend(button);
  547. $('[data-toggle="tooltip"]').tooltip();
  548. $('[data-toggle="tooltip"]').mouseout(function() {
  549. $(this).tooltip('hide');
  550. $(this).trigger('blur');
  551. });
  552. var clipboard = new Clipboard('.c2cb', {
  553. target: function(c2cb) {
  554. return $(c2cb).parent().siblings("code")[0];
  555. }
  556. });
  557. clipboard.on('success', function(e) {
  558. e.clearSelection();
  559. });
  560. });
  561. </script>
  562. </head>
  563. <body class="article toc2 toc-left">
  564. <div id="header">
  565. <h1><a id="spring-boot-web"></a>Spring Boot Web</h1>
  566. <div id="toc" class="toc2">
  567. <div id="toctitle">Labs</div>
  568. <ul class="sectlevel1">
  569. <li><a href="#_code_snippet_manager">Code Snippet Manager</a></li>
  570. <li><a href="#_challenges">Challenges</a>
  571. <ul class="sectlevel2">
  572. <li><a href="#_adding_a_ui_home_page">Adding a UI - Home Page</a></li>
  573. <li><a href="#_rest_api">REST API</a></li>
  574. </ul>
  575. </li>
  576. <li><a href="#__homework">[HOMEWORK]</a></li>
  577. </ul>
  578. </div>
  579. </div>
  580. <div id="content">
  581. <div id="preamble">
  582. <div class="sectionbody">
  583. <div class="paragraph">
  584. <p>Get familiar with the <strong>Spring MVC</strong> and the <strong>Spring Boot Web applications</strong>.</p>
  585. </div>
  586. <div class="paragraph">
  587. <p><strong>Time:</strong> 30 minutes.</p>
  588. </div>
  589. <!-- toc disabled -->
  590. </div>
  591. </div>
  592. <div class="sect1">
  593. <h2 id="_code_snippet_manager">Code Snippet Manager</h2>
  594. <div class="sectionbody">
  595. <div class="paragraph">
  596. <p>As developers normally we require to have some <strong><em>code snippets</em></strong> that help us to code fast and safe.</p>
  597. </div>
  598. <div class="paragraph">
  599. <p>The main idea of this application is to create a site that can manage our <strong>Code Snippets</strong>. We are going to create a <strong>RESTful API</strong> for any external client.</p>
  600. </div>
  601. <div class="olist arabic">
  602. <ol class="arabic">
  603. <li>
  604. <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
  605. </li>
  606. <li>
  607. <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
  608. </li>
  609. <li>
  610. <p>Fill out the <strong>Code Snippet Manager</strong> Project metadata with (See Figure 1.0):</p>
  611. <table class="tableblock frame-all grid-all spread">
  612. <caption class="title">Table 1. Code Snippet Manager App - metadata</caption>
  613. <colgroup>
  614. <col style="width: 16.6666%;">
  615. <col style="width: 83.3334%;">
  616. </colgroup>
  617. <thead>
  618. <tr>
  619. <th class="tableblock halign-left valign-top">Property</th>
  620. <th class="tableblock halign-left valign-top">Value</th>
  621. </tr>
  622. </thead>
  623. <tbody>
  624. <tr>
  625. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
  626. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  627. </tr>
  628. <tr>
  629. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
  630. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>code-snippet-manager</em></p></td>
  631. </tr>
  632. <tr>
  633. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
  634. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>code-snippet-manager</em></p></td>
  635. </tr>
  636. <tr>
  637. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
  638. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop.snippet</em></p></td>
  639. </tr>
  640. <tr>
  641. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Dependencies</strong>:</p></td>
  642. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Web, DevTools, Groovy Templates</em></p></td>
  643. </tr>
  644. <tr>
  645. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
  646. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. <div class="paragraph">
  651. <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io/" class="bare" target="_blank">http://start.spring.io/</a></div>
  652. <p><span class="image"><img src="images/05-spring-boot-web-01.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
  653. </div>
  654. <div class="admonitionblock tip">
  655. <table>
  656. <tr>
  657. <td class="icon">
  658. <div class="title">Tip</div>
  659. </td>
  660. <td class="content">
  661. You can choose either <strong>Maven</strong> or <strong>Gradle</strong> project types.
  662. </td>
  663. </tr>
  664. </table>
  665. </div>
  666. </li>
  667. <li>
  668. <p>Type <strong>Web</strong>, <strong>DevTools</strong>, <strong>Groovy Templates</strong>, in the <strong><em>Dependencies</em></strong> field and press Enter.</p>
  669. </li>
  670. <li>
  671. <p>Click the <strong><em>Generate Project</em></strong> button.</p>
  672. </li>
  673. <li>
  674. <p>Unzip the file in any directory you want.</p>
  675. </li>
  676. <li>
  677. <p>Import your project in any IDE you want.</p>
  678. </li>
  679. <li>
  680. <p>Let&#8217;s start by defining the domain models. Create the following classes:</p>
  681. <div class="listingblock">
  682. <div class="title">io.pivotal.workshop.snippet.domain.Language.java</div>
  683. <div class="content">
  684. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.domain</span>;
  685. <span class="directive">public</span> <span class="type">class</span> <span class="class">Language</span> {
  686. <span class="directive">private</span> <span class="predefined-type">String</span> id;
  687. <span class="directive">private</span> <span class="predefined-type">String</span> name;
  688. <span class="directive">private</span> <span class="predefined-type">String</span> syntax = <span class="string"><span class="delimiter">&quot;</span><span class="content">text</span><span class="delimiter">&quot;</span></span>;
  689. <span class="directive">public</span> Language() {
  690. <span class="local-variable">this</span>.id = java.util.UUID.randomUUID().toString().replaceAll(<span class="string"><span class="delimiter">&quot;</span><span class="content">-</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>);;
  691. }
  692. <span class="directive">public</span> Language(<span class="predefined-type">String</span> name) {
  693. <span class="local-variable">this</span>();
  694. <span class="local-variable">this</span>.name = name;
  695. }
  696. <span class="directive">public</span> Language(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> syntax) {
  697. <span class="local-variable">this</span>(name);
  698. <span class="local-variable">this</span>.syntax = syntax;
  699. }
  700. <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
  701. <span class="keyword">return</span> id;
  702. }
  703. <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
  704. <span class="local-variable">this</span>.id = id;
  705. }
  706. <span class="directive">public</span> <span class="predefined-type">String</span> getName() {
  707. <span class="keyword">return</span> name;
  708. }
  709. <span class="directive">public</span> <span class="type">void</span> setName(<span class="predefined-type">String</span> name) {
  710. <span class="local-variable">this</span>.name = name;
  711. }
  712. <span class="directive">public</span> <span class="predefined-type">String</span> getSyntax() {
  713. <span class="keyword">return</span> syntax;
  714. }
  715. <span class="directive">public</span> <span class="type">void</span> setSyntax(<span class="predefined-type">String</span> syntax) {
  716. <span class="local-variable">this</span>.syntax = syntax;
  717. }
  718. }</code></pre>
  719. </div>
  720. </div>
  721. <div class="paragraph">
  722. <p>We can have multiple snippets in different programming languages, that&#8217;s why we have this class. Take a look that also there is a <strong>syntax</strong> field; this field will be use later on for <strong><em>syntax highlight</em></strong>.</p>
  723. </div>
  724. <div class="listingblock">
  725. <div class="title">io.pivotal.workshop.snippet.domain.Code.java</div>
  726. <div class="content">
  727. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.domain</span>;
  728. <span class="directive">public</span> <span class="type">class</span> <span class="class">Code</span> {
  729. <span class="directive">private</span> <span class="predefined-type">String</span> id;
  730. <span class="directive">private</span> <span class="predefined-type">String</span> source;
  731. <span class="directive">public</span> Code() {
  732. <span class="local-variable">this</span>.id = java.util.UUID.randomUUID().toString().replaceAll(<span class="string"><span class="delimiter">&quot;</span><span class="content">-</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>);;
  733. }
  734. <span class="directive">public</span> Code(<span class="predefined-type">String</span> source) {
  735. <span class="local-variable">this</span>();
  736. <span class="local-variable">this</span>.source = source;
  737. }
  738. <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
  739. <span class="keyword">return</span> id;
  740. }
  741. <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
  742. <span class="local-variable">this</span>.id = id;
  743. }
  744. <span class="directive">public</span> <span class="predefined-type">String</span> getSource() {
  745. <span class="keyword">return</span> source;
  746. }
  747. <span class="directive">public</span> <span class="type">void</span> setSource(<span class="predefined-type">String</span> source) {
  748. <span class="local-variable">this</span>.source = source;
  749. }
  750. }</code></pre>
  751. </div>
  752. </div>
  753. <div class="paragraph">
  754. <p>This class will be use to hold the actual snippet code.</p>
  755. </div>
  756. <div class="listingblock">
  757. <div class="title">io.pivotal.workshop.snippet.domain.Snippet.java</div>
  758. <div class="content">
  759. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.domain</span>;
  760. <span class="keyword">import</span> <span class="include">java.util.Date</span>;
  761. <span class="directive">public</span> <span class="type">class</span> <span class="class">Snippet</span> {
  762. <span class="directive">private</span> <span class="predefined-type">String</span> id;
  763. <span class="directive">private</span> <span class="predefined-type">String</span> title;
  764. <span class="directive">private</span> <span class="predefined-type">String</span> keywords;
  765. <span class="directive">private</span> <span class="predefined-type">String</span> description;
  766. <span class="directive">private</span> Language lang;
  767. <span class="directive">private</span> Code code;
  768. <span class="directive">private</span> <span class="predefined-type">Date</span> created;
  769. <span class="directive">private</span> <span class="predefined-type">Date</span> modified;
  770. <span class="directive">public</span> Snippet() {
  771. <span class="local-variable">this</span>.id = java.util.UUID.randomUUID().toString().replaceAll(<span class="string"><span class="delimiter">&quot;</span><span class="content">-</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>);
  772. <span class="local-variable">this</span>.created = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  773. <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  774. }
  775. <span class="directive">public</span> Snippet(<span class="predefined-type">String</span> title, <span class="predefined-type">String</span> keywords, <span class="predefined-type">String</span> description, Language lang, Code code) {
  776. <span class="local-variable">this</span>();
  777. <span class="local-variable">this</span>.title = title;
  778. <span class="local-variable">this</span>.keywords = keywords;
  779. <span class="local-variable">this</span>.description = description;
  780. <span class="local-variable">this</span>.lang = lang;
  781. <span class="local-variable">this</span>.code = code;
  782. }
  783. <span class="directive">public</span> Snippet(<span class="predefined-type">String</span> title, Language lang, Code code) {
  784. <span class="local-variable">this</span>(title, <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>, lang, code);
  785. }
  786. <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
  787. <span class="keyword">return</span> id;
  788. }
  789. <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
  790. <span class="local-variable">this</span>.id = id;
  791. }
  792. <span class="directive">public</span> <span class="predefined-type">String</span> getTitle() {
  793. <span class="keyword">return</span> title;
  794. }
  795. <span class="directive">public</span> <span class="type">void</span> setTitle(<span class="predefined-type">String</span> title) {
  796. <span class="local-variable">this</span>.title = title;
  797. }
  798. <span class="directive">public</span> Language getLang() {
  799. <span class="keyword">return</span> lang;
  800. }
  801. <span class="directive">public</span> <span class="type">void</span> setLang(Language lang) {
  802. <span class="local-variable">this</span>.lang = lang;
  803. }
  804. <span class="directive">public</span> <span class="predefined-type">String</span> getDescription() {
  805. <span class="keyword">return</span> description;
  806. }
  807. <span class="directive">public</span> <span class="type">void</span> setDescription(<span class="predefined-type">String</span> description) {
  808. <span class="local-variable">this</span>.description = description;
  809. }
  810. <span class="directive">public</span> <span class="predefined-type">String</span> getKeywords() {
  811. <span class="keyword">return</span> keywords;
  812. }
  813. <span class="directive">public</span> <span class="type">void</span> setKeywords(<span class="predefined-type">String</span> keywords) {
  814. <span class="local-variable">this</span>.keywords = keywords;
  815. }
  816. <span class="directive">public</span> Code getCode() {
  817. <span class="keyword">return</span> code;
  818. }
  819. <span class="directive">public</span> <span class="type">void</span> setCode(Code code) {
  820. <span class="local-variable">this</span>.code = code;
  821. }
  822. <span class="directive">public</span> <span class="predefined-type">Date</span> getCreated() {
  823. <span class="keyword">return</span> created;
  824. }
  825. <span class="directive">public</span> <span class="type">void</span> setCreated(<span class="predefined-type">Date</span> created) {
  826. <span class="local-variable">this</span>.created = created;
  827. }
  828. <span class="directive">public</span> <span class="predefined-type">Date</span> getModified() {
  829. <span class="keyword">return</span> modified;
  830. }
  831. <span class="directive">public</span> <span class="type">void</span> setModified(<span class="predefined-type">Date</span> modified) {
  832. <span class="local-variable">this</span>.modified = modified;
  833. }
  834. }</code></pre>
  835. </div>
  836. </div>
  837. <div class="paragraph">
  838. <p>The above class will be the main reponse.</p>
  839. </div>
  840. </li>
  841. <li>
  842. <p>Next let&#8217;s create a base interface that will be use as main <strong>repository</strong>. In this case we are going to hold all the data in <strong>Memory</strong> using <strong>collections</strong>:</p>
  843. <div class="listingblock">
  844. <div class="title">io.pivotal.workshop.snippet.repository.SimpleRepository.java</div>
  845. <div class="content">
  846. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.repository</span>;
  847. <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
  848. <span class="directive">public</span> <span class="type">interface</span> <span class="class">SimpleRepository</span>&lt;T&gt; {
  849. <span class="predefined-type">Iterable</span>&lt;T&gt; findAll();
  850. <span class="type">void</span> saveAll(<span class="predefined-type">Collection</span>&lt;T&gt; items);
  851. T saveAll(T item);
  852. T findById(<span class="predefined-type">String</span> id);
  853. }</code></pre>
  854. </div>
  855. </div>
  856. <div class="paragraph">
  857. <p>as you can see it has just the most common actions.</p>
  858. </div>
  859. </li>
  860. <li>
  861. <p>Let&#8217;s create now all the Repositories that will be implementing the <strong>SimpleRepository</strong> interface.</p>
  862. <div class="listingblock">
  863. <div class="title">io.pivotal.workshop.snippet.repository.LanguageRepository.java</div>
  864. <div class="content">
  865. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.repository</span>;
  866. <span class="keyword">import</span> <span class="include">java.util.ArrayList</span>;
  867. <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
  868. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  869. <span class="keyword">import</span> <span class="include">java.util.Optional</span>;
  870. <span class="keyword">import</span> <span class="include">java.util.stream.StreamSupport</span>;
  871. <span class="keyword">import</span> <span class="include">org.springframework.stereotype.Repository</span>;
  872. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Language</span>;
  873. <span class="annotation">@Repository</span>
  874. <span class="directive">public</span> <span class="type">class</span> <span class="class">LanguageRepository</span> <span class="directive">implements</span> SimpleRepository&lt;Language&gt;{
  875. <span class="directive">private</span> <span class="predefined-type">List</span>&lt;Language&gt; languages = <span class="keyword">new</span> <span class="predefined-type">ArrayList</span>&lt;&gt;();
  876. <span class="directive">public</span> <span class="predefined-type">Iterable</span>&lt;Language&gt; findAll(){
  877. <span class="keyword">return</span> languages;
  878. }
  879. <span class="directive">public</span> <span class="type">void</span> saveAll(<span class="predefined-type">Collection</span>&lt;Language&gt; languages){
  880. <span class="local-variable">this</span>.languages.addAll(languages);
  881. }
  882. <span class="directive">public</span> Language findById(<span class="predefined-type">String</span> name) {
  883. Optional&lt;Language&gt; language = StreamSupport
  884. .stream(<span class="local-variable">this</span>.languages.spliterator(), <span class="predefined-constant">false</span>)
  885. .filter(lang -&gt; lang.getName().equals(name))
  886. .findFirst();
  887. <span class="keyword">if</span> (language.isPresent()) <span class="keyword">return</span> language.get();
  888. <span class="keyword">return</span> <span class="predefined-constant">null</span>;
  889. }
  890. <span class="directive">public</span> Language saveAll(Language item) {
  891. <span class="keyword">assert</span> item.getName() != <span class="predefined-constant">null</span>;
  892. Language language = <span class="local-variable">this</span>.findById(item.getName());
  893. <span class="keyword">if</span>(language == <span class="predefined-constant">null</span>) {
  894. <span class="local-variable">this</span>.languages.add(item);
  895. <span class="keyword">return</span> item;
  896. }<span class="keyword">else</span> {
  897. language.setName(item.getName());
  898. language.setSyntax(item.getSyntax());
  899. <span class="keyword">return</span> language;
  900. }
  901. }
  902. }</code></pre>
  903. </div>
  904. </div>
  905. <div class="listingblock">
  906. <div class="title">io.pivotal.workshop.snippet.repository.CodeRepository.java</div>
  907. <div class="content">
  908. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.repository</span>;
  909. <span class="keyword">import</span> <span class="include">java.util.ArrayList</span>;
  910. <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
  911. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  912. <span class="keyword">import</span> <span class="include">java.util.Optional</span>;
  913. <span class="keyword">import</span> <span class="include">org.springframework.stereotype.Repository</span>;
  914. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Code</span>;
  915. <span class="annotation">@Repository</span>
  916. <span class="directive">public</span> <span class="type">class</span> <span class="class">CodeRepository</span> <span class="directive">implements</span> SimpleRepository&lt;Code&gt;{
  917. <span class="directive">private</span> <span class="predefined-type">List</span>&lt;Code&gt; codes = <span class="keyword">new</span> <span class="predefined-type">ArrayList</span>&lt;&gt;();
  918. <span class="directive">public</span> <span class="predefined-type">List</span>&lt;Code&gt; findAll() {
  919. <span class="keyword">return</span> codes;
  920. }
  921. <span class="annotation">@Override</span>
  922. <span class="directive">public</span> <span class="type">void</span> saveAll(<span class="predefined-type">Collection</span>&lt;Code&gt; items) {
  923. <span class="local-variable">this</span>.codes.addAll(items);
  924. }
  925. <span class="annotation">@Override</span>
  926. <span class="directive">public</span> Code saveAll(Code item) {
  927. <span class="keyword">assert</span> item.getSource() != <span class="predefined-constant">null</span>;
  928. Code code = findById(item.getId());
  929. <span class="keyword">if</span>(code == <span class="predefined-constant">null</span>){
  930. <span class="local-variable">this</span>.codes.add(item);
  931. <span class="keyword">return</span> item;
  932. }
  933. <span class="keyword">else</span> {
  934. code.setSource(item.getSource());
  935. <span class="keyword">return</span> code;
  936. }
  937. }
  938. <span class="annotation">@Override</span>
  939. <span class="directive">public</span> Code findById(<span class="predefined-type">String</span> id) {
  940. Optional&lt;Code&gt; code = codes
  941. .stream()
  942. .filter(c -&gt; c.getId().equals(id))
  943. .findFirst();
  944. <span class="keyword">if</span> (code.isPresent()) <span class="keyword">return</span> code.get();
  945. <span class="keyword">return</span> <span class="predefined-constant">null</span>;
  946. }
  947. }</code></pre>
  948. </div>
  949. </div>
  950. <div class="listingblock">
  951. <div class="title">io.pivotal.workshop.snippet.repository.SnippetRepository.java</div>
  952. <div class="content">
  953. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.repository</span>;
  954. <span class="keyword">import</span> <span class="include">java.util.ArrayList</span>;
  955. <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
  956. <span class="keyword">import</span> <span class="include">java.util.Date</span>;
  957. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  958. <span class="keyword">import</span> <span class="include">java.util.Optional</span>;
  959. <span class="keyword">import</span> <span class="include">org.springframework.stereotype.Repository</span>;
  960. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Snippet</span>;
  961. <span class="annotation">@Repository</span>
  962. <span class="directive">public</span> <span class="type">class</span> <span class="class">SnippetRepository</span> <span class="directive">implements</span> SimpleRepository&lt;Snippet&gt;{
  963. <span class="directive">private</span> <span class="predefined-type">List</span>&lt;Snippet&gt; snippets = <span class="keyword">new</span> <span class="predefined-type">ArrayList</span>&lt;&gt;();
  964. <span class="annotation">@Override</span>
  965. <span class="directive">public</span> Snippet saveAll(Snippet snippet){
  966. <span class="keyword">assert</span> snippet.getTitle() != <span class="predefined-constant">null</span>;
  967. <span class="keyword">assert</span> snippet.getCode() != <span class="predefined-constant">null</span>;
  968. <span class="keyword">assert</span> snippet.getLang() != <span class="predefined-constant">null</span>;
  969. Snippet _snippet = <span class="predefined-constant">null</span>;
  970. <span class="keyword">if</span> (snippet.getId() == <span class="predefined-constant">null</span>) {
  971. _snippet = <span class="keyword">new</span> Snippet(snippet.getTitle(), snippet.getLang(),snippet.getCode());
  972. } <span class="keyword">else</span> {
  973. _snippet = <span class="local-variable">this</span>.findById(snippet.getId());
  974. <span class="keyword">if</span>(_snippet != <span class="predefined-constant">null</span>){
  975. _snippet.setTitle(snippet.getTitle());
  976. _snippet.setCode(snippet.getCode());
  977. _snippet.setLang(snippet.getLang());
  978. _snippet.setModified(<span class="keyword">new</span> <span class="predefined-type">Date</span>());
  979. }
  980. }
  981. <span class="keyword">return</span> _snippet;
  982. }
  983. <span class="annotation">@Override</span>
  984. <span class="directive">public</span> <span class="predefined-type">Iterable</span>&lt;Snippet&gt; findAll(){
  985. <span class="keyword">return</span> <span class="local-variable">this</span>.snippets;
  986. }
  987. <span class="annotation">@Override</span>
  988. <span class="directive">public</span> Snippet findById(<span class="predefined-type">String</span> id){
  989. Optional&lt;Snippet&gt; result = snippets.stream()
  990. .filter(snippet -&gt; snippet.getId().equals(id))
  991. .findFirst();
  992. <span class="keyword">if</span> (result.isPresent()) <span class="keyword">return</span> result.get();
  993. <span class="keyword">return</span> <span class="predefined-constant">null</span>;
  994. }
  995. <span class="annotation">@Override</span>
  996. <span class="directive">public</span> <span class="type">void</span> saveAll(<span class="predefined-type">Collection</span>&lt;Snippet&gt; items) {
  997. <span class="local-variable">this</span>.snippets.addAll(items);
  998. }
  999. }</code></pre>
  1000. </div>
  1001. </div>
  1002. </li>
  1003. <li>
  1004. <p>Next lets do the main controller that will expose the REST API:</p>
  1005. <div id="snippetController" class="listingblock">
  1006. <div class="title">io.pivotal.workshop.snippet.controller.SnippetController.java</div>
  1007. <div class="content">
  1008. <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@RestController</span>
  1009. <span class="directive">public</span> <span class="type">class</span> <span class="class">SnippetController</span> {
  1010. <span class="directive">private</span> SnippetRepository snippetRepository;
  1011. <span class="directive">private</span> LanguageRepository languageRepository;
  1012. <span class="directive">public</span> SnippetController(SnippetRepository snippetRepository,LanguageRepository languageRepository){
  1013. <span class="local-variable">this</span>.snippetRepository = snippetRepository;
  1014. <span class="local-variable">this</span>.languageRepository = languageRepository;
  1015. }
  1016. <span class="annotation">@RequestMapping</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">/</span><span class="delimiter">&quot;</span></span>)
  1017. <span class="directive">public</span> ModelAndView home(){
  1018. <span class="keyword">assert</span> snippetRepository != <span class="predefined-constant">null</span>;
  1019. <span class="predefined-type">Map</span>&lt;<span class="predefined-type">String</span>,<span class="predefined-type">Object</span>&gt; model = <span class="keyword">new</span> <span class="predefined-type">HashMap</span>&lt;<span class="predefined-type">String</span>,<span class="predefined-type">Object</span>&gt;();
  1020. model.put(<span class="string"><span class="delimiter">&quot;</span><span class="content">langs</span><span class="delimiter">&quot;</span></span>, languageRepository.findAll());
  1021. model.put(<span class="string"><span class="delimiter">&quot;</span><span class="content">snippets</span><span class="delimiter">&quot;</span></span>, snippetRepository.findAll());
  1022. <span class="keyword">return</span> <span class="keyword">new</span> ModelAndView(<span class="string"><span class="delimiter">&quot;</span><span class="content">views/home</span><span class="delimiter">&quot;</span></span>,model);
  1023. }
  1024. <span class="annotation">@RequestMapping</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">/snippets</span><span class="delimiter">&quot;</span></span>)
  1025. <span class="directive">public</span> ResponseEntity&lt;?&gt; snippets(){
  1026. <span class="keyword">assert</span> snippetRepository != <span class="predefined-constant">null</span>;
  1027. <span class="keyword">return</span> ResponseEntity.ok(snippetRepository.findAll());
  1028. }
  1029. }</code></pre>
  1030. </div>
  1031. </div>
  1032. </li>
  1033. <li>
  1034. <p>Create a configuration class to initialize your repositories:</p>
  1035. <div class="listingblock">
  1036. <div class="title">io.pivotal.workshop.snippet.config.SnippetConfiguration.java</div>
  1037. <div class="content">
  1038. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.config</span>;
  1039. <span class="keyword">import</span> <span class="include">java.nio.file.Files</span>;
  1040. <span class="keyword">import</span> <span class="include">java.nio.file.Paths</span>;
  1041. <span class="keyword">import</span> <span class="include">java.util.ArrayList</span>;
  1042. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  1043. <span class="keyword">import</span> <span class="include">org.springframework.boot.CommandLineRunner</span>;
  1044. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  1045. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
  1046. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Code</span>;
  1047. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Language</span>;
  1048. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.domain.Snippet</span>;
  1049. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.snippet.repository.SnippetRepository</span>;
  1050. <span class="annotation">@Configuration</span>
  1051. <span class="directive">public</span> <span class="type">class</span> <span class="class">SnippetConfiguration</span> {
  1052. <span class="annotation">@Bean</span>
  1053. <span class="directive">public</span> CommandLineRunner runner(SnippetRepository snippetRepo) {
  1054. <span class="keyword">return</span> args -&gt; {
  1055. <span class="annotation">@SuppressWarnings</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">serial</span><span class="delimiter">&quot;</span></span>)
  1056. <span class="predefined-type">List</span>&lt;Snippet&gt; snippets = <span class="keyword">new</span> <span class="predefined-type">ArrayList</span>&lt;Snippet&gt;() {
  1057. {
  1058. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">HTML</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">xml</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="keyword">new</span> <span class="predefined-type">String</span>(Files.readAllBytes(Paths.get(<span class="string"><span class="delimiter">&quot;</span><span class="content">code/html-code.txt</span><span class="delimiter">&quot;</span></span>))))));
  1059. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">C#</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">c#</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="keyword">new</span> <span class="predefined-type">String</span>(Files.readAllBytes(Paths.get(<span class="string"><span class="delimiter">&quot;</span><span class="content">code/cs-code.txt</span><span class="delimiter">&quot;</span></span>))))));
  1060. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">Pascal</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">py</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="keyword">new</span> <span class="predefined-type">String</span>(Files.readAllBytes(Paths.get(<span class="string"><span class="delimiter">&quot;</span><span class="content">code/pas-code.txt</span><span class="delimiter">&quot;</span></span>))))));
  1061. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">Erlang</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">erl</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="keyword">new</span> <span class="predefined-type">String</span>(Files.readAllBytes(Paths.get(<span class="string"><span class="delimiter">&quot;</span><span class="content">code/erl-code.txt</span><span class="delimiter">&quot;</span></span>))))));
  1062. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">JavaScript</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">js</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="keyword">new</span> <span class="predefined-type">String</span>(Files.readAllBytes(Paths.get(<span class="string"><span class="delimiter">&quot;</span><span class="content">code/js-code.txt</span><span class="delimiter">&quot;</span></span>))))));
  1063. add(<span class="keyword">new</span> Snippet(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> Language(<span class="string"><span class="delimiter">&quot;</span><span class="content">Groovy</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">groovy</span><span class="delimiter">&quot;</span></span>),<span class="keyword">new</span> Code(<span class="string"><span class="delimiter">&quot;</span><span class="content">println 'Hello World'</span><span class="delimiter">&quot;</span></span>)));
  1064. }
  1065. };
  1066. snippetRepo.saveAll(snippets);
  1067. };
  1068. }
  1069. }</code></pre>
  1070. </div>
  1071. </div>
  1072. <div class="paragraph">
  1073. <p>as you can see from the above code, we are building up our data.</p>
  1074. </div>
  1075. <div class="paragraph">
  1076. <p>If you take a close look, we are using the <strong>Files.readAllBytes</strong> helper class to read from a file, and this file is located in the <strong>code/</strong> folder.</p>
  1077. </div>
  1078. </li>
  1079. <li>
  1080. <p>Add some code snippets in the <strong>code/</strong> folder.</p>
  1081. <div class="listingblock">
  1082. <div class="title">code/html-code.txt - HTML</div>
  1083. <div class="content">
  1084. <pre class="CodeRay highlight"><code data-lang="java">&lt;html&gt;
  1085. &lt;body&gt;
  1086. &lt;h1&gt;Hello World&lt;/h1&gt;
  1087. &lt;/body&gt;
  1088. &lt;/html&gt;</code></pre>
  1089. </div>
  1090. </div>
  1091. <div class="listingblock">
  1092. <div class="title">code/cs-code.txt - C#</div>
  1093. <div class="content">
  1094. <pre class="CodeRay highlight"><code data-lang="csharp">class Hello {
  1095. static void Main() {
  1096. System.Console.Write(&quot;Hello World&quot;);
  1097. }
  1098. }</code></pre>
  1099. </div>
  1100. </div>
  1101. <div class="listingblock">
  1102. <div class="title">code/pas-code.txt - Pascal</div>
  1103. <div class="content">
  1104. <pre class="CodeRay highlight"><code data-lang="ruby">program <span class="constant">HelloWorld</span>;
  1105. <span class="keyword">begin</span>
  1106. writeln(<span class="string"><span class="delimiter">'</span><span class="content">Hello World</span><span class="delimiter">'</span></span>);
  1107. <span class="keyword">end</span>.</code></pre>
  1108. </div>
  1109. </div>
  1110. <div class="listingblock">
  1111. <div class="title">code/erl-code.txt - Erlang</div>
  1112. <div class="content">
  1113. <pre class="CodeRay highlight"><code data-lang="ruby"> -<span class="keyword">module</span>(hello).
  1114. -export([hello_world/<span class="integer">0</span>]).
  1115. hello_world() -&gt; <span class="key">io</span>:fwrite(<span class="string"><span class="delimiter">&quot;</span><span class="content">hello, world</span><span class="char">\n</span><span class="delimiter">&quot;</span></span>).</code></pre>
  1116. </div>
  1117. </div>
  1118. <div class="listingblock">
  1119. <div class="title">code/js-code.txt - JavaScript</div>
  1120. <div class="content">
  1121. <pre class="CodeRay highlight"><code data-lang="ruby">console.log(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello World</span><span class="delimiter">&quot;</span></span>);</code></pre>
  1122. </div>
  1123. </div>
  1124. </li>
  1125. <li>
  1126. <p>A lot of code, right? Well now its time to run the application. You can use your IDE or command line. Once running you application, go to your browser and hit: <a href="http://localhost:8080/snippets" class="bare" target="_blank">http://localhost:8080/snippets</a> and you should get the a response like Figure 2.0.</p>
  1127. <div class="paragraph">
  1128. <div class="title">Figure 2.0: Snippet Code Manager - <a href="http://localhost:8080/snippets" class="bare" target="_blank">http://localhost:8080/snippets</a></div>
  1129. <p><span class="image"><img src="images/05-spring-boot-web-02.png" alt="/snippets" title="Snippet Code Manager"></span></p>
  1130. </div>
  1131. </li>
  1132. </ol>
  1133. </div>
  1134. </div>
  1135. </div>
  1136. <div class="sect1">
  1137. <h2 id="_challenges">Challenges</h2>
  1138. <div class="sectionbody">
  1139. <div class="sect2">
  1140. <h3 id="_adding_a_ui_home_page">Adding a UI - Home Page</h3>
  1141. <div class="paragraph">
  1142. <p>You can see that the <a href="#snippetController">io.pivotal.workshop.snippet.controller.SnippetController.java</a> has the <strong><em>home</em></strong>() method, and it returns the view: <strong><em>views/home</em></strong> and the <strong><em>model</em></strong>, a map that contains the languages and the snippets:
  1143. Add the following missing dependencies to your <strong>pom.xml</strong> because you will need them:</p>
  1144. </div>
  1145. <div class="listingblock">
  1146. <div class="content">
  1147. <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
  1148. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  1149. <span class="tag">&lt;artifactId&gt;</span>jquery<span class="tag">&lt;/artifactId&gt;</span>
  1150. <span class="tag">&lt;version&gt;</span>2.2.4<span class="tag">&lt;/version&gt;</span>
  1151. <span class="tag">&lt;/dependency&gt;</span>
  1152. <span class="tag">&lt;dependency&gt;</span>
  1153. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  1154. <span class="tag">&lt;artifactId&gt;</span>bootstrap<span class="tag">&lt;/artifactId&gt;</span>
  1155. <span class="tag">&lt;version&gt;</span>3.3.6<span class="tag">&lt;/version&gt;</span>
  1156. <span class="tag">&lt;/dependency&gt;</span>
  1157. <span class="tag">&lt;dependency&gt;</span>
  1158. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  1159. <span class="tag">&lt;artifactId&gt;</span>angularjs<span class="tag">&lt;/artifactId&gt;</span>
  1160. <span class="tag">&lt;version&gt;</span>1.5.7<span class="tag">&lt;/version&gt;</span>
  1161. <span class="tag">&lt;/dependency&gt;</span></code></pre>
  1162. </div>
  1163. </div>
  1164. <div class="paragraph">
  1165. <p>Add the following libraries in the <strong>src/main/resources/static/css</strong>:
  1166. <a href="artifacts/spring-boot-web/theme.html" target="_blank">theme.css</a> and <a href="artifacts/spring-boot-web/offcanvas.html" target="_blank">offcanvas.css</a>
  1167. and in the <strong>src/main/resources/static/js</strong> folder add the <a href="artifacts/spring-boot-web/syntaxhighlighter.html" target="_blank">syntaxhighlighter.js</a> script.</p>
  1168. </div>
  1169. <div class="ulist">
  1170. <ul>
  1171. <li>
  1172. <p>Create the necessary layout and home page to have the same as Figure 3.0.</p>
  1173. <div class="paragraph">
  1174. <div class="title">Figure 3.0: Code Snippet Manager - <a href="http://localhost:8080" class="bare" target="_blank">http://localhost:8080</a></div>
  1175. <p><span class="image"><img src="images/05-spring-boot-web-03.png" alt="/" title="Snippet Code Manager"></span></p>
  1176. </div>
  1177. </li>
  1178. </ul>
  1179. </div>
  1180. <div class="admonitionblock tip">
  1181. <table>
  1182. <tr>
  1183. <td class="icon">
  1184. <div class="title">Tip</div>
  1185. </td>
  1186. <td class="content">
  1187. You can take a look at the Groovy Template Engine: <a href="http://docs.groovy-lang.org/next/html/documentation/template-engines.html#_the_markuptemplateengine" class="bare" target="_blank">http://docs.groovy-lang.org/next/html/documentation/template-engines.html#_the_markuptemplateengine</a>
  1188. </td>
  1189. </tr>
  1190. </table>
  1191. </div>
  1192. </div>
  1193. <div class="sect2">
  1194. <h3 id="_rest_api">REST API</h3>
  1195. <div class="ulist">
  1196. <ul>
  1197. <li>
  1198. <p>Complete the RESTful API:</p>
  1199. <div class="ulist">
  1200. <ul>
  1201. <li>
  1202. <p>provide the <strong>/snippets/{id}</strong> path endpoint to search by snippet Id.</p>
  1203. </li>
  1204. <li>
  1205. <p>provide methods to handle the: <strong>POST</strong>, <strong>PUT</strong> for adding a new snippet and updating the snippet.</p>
  1206. </li>
  1207. </ul>
  1208. </div>
  1209. </li>
  1210. <li>
  1211. <p>Make changes to repose either <strong>JSON</strong> or <strong>XML</strong>.</p>
  1212. </li>
  1213. <li>
  1214. <p>When doing a XML response, the snippet code should be in a <strong>CDATA</strong> tag. Modify the code to show a <strong>CDATA</strong> for every source code. (<strong>tip</strong>: <strong><em>@JacksonXmlCData</em></strong>)</p>
  1215. </li>
  1216. </ul>
  1217. </div>
  1218. </div>
  1219. </div>
  1220. </div>
  1221. <div class="sect1">
  1222. <h2 id="__homework">[HOMEWORK]</h2>
  1223. <div class="sectionbody">
  1224. <div class="ulist">
  1225. <ul>
  1226. <li>
  1227. <p>Add validation to the <strong>POST</strong> and <strong>PUT</strong> methods (<strong>tip</strong>: <em>@Valid</em>).</p>
  1228. </li>
  1229. <li>
  1230. <p>Finish up any missing <strong>UI</strong> or <strong>Controller</strong> methods.</p>
  1231. </li>
  1232. </ul>
  1233. </div>
  1234. </div>
  1235. </div>
  1236. </div>
  1237. <div id="footer">
  1238. <div id="footer-text">
  1239. Last updated 2017-11-18 11:05:06 PST
  1240. </div>
  1241. </div>
  1242. </body>
  1243. </html>