(5.x) Development Guideline Documentation

1735 Pages·2016·23.32 MB·English

TERASOLUNA Server Framework for
Java (5.x) Development Guideline
Documentation
Release 5.0.2.RELEASE
NTT DATA
April13,2016

i
CONTENTS
1 IntheBeginning 3
1.1 TermsofUse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Thisdocumentcoversthefollowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3 Targetreadersofthisdocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.4 Structureofthisdocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 Readingthisdocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.6 Testedenvironmentsofthisdocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.7 Criteriabasedmappingofguideline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.8 ChangeLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2 Summary-ArchitectureofTERASOLUNAServerFrameworkforJava(5.x) 29
2.1 StackofTERASOLUNAServerFrameworkforJava(5.x) . . . . . . . . . . . . . . . . . . . . . 29
2.2 OverviewofSpringMVCArchitecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.3 FirstapplicationbasedonSpringMVC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.4 ApplicationLayering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3 Tutorial(TodoApplication) 81
3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.2 Descriptionofapplicationtobecreated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.3 Environmentcreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
3.4 CreationofTodoapplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.5 CreatinginfrastructurelayerwithaDatabaseaccess . . . . . . . . . . . . . . . . . . . . . . . . 143
3.6 Intheend... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.7 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
4 ApplicationDevelopmentusingTERASOLUNAServerFrameworkforJava(5.x) 183
4.1 CreateWebapplicationdevelopmentproject . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
4.2 DomainLayerImplementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
4.3 ImplementationofInfrastructureLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
4.4 ImplementationofApplicationLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5 ArchitectureinDetail-TERASOLUNAServerFrameworkforJava(5.x) 383
5.1 DatabaseAccess(Common) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
5.2 DatabaseAccess(MyBatis3). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
5.3 DatabaseAccess(JPA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
5.4 ExclusiveControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
5.5 InputValidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
5.6 Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
5.7 ExceptionHandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
5.8 SessionManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
5.9 MessageManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
5.10 PropertiesManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
5.11 Pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
5.12 DoubleSubmitProtection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
5.13 Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075
5.14 Codelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
5.15 Ajax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
5.16 RESTfulWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160
5.17 FileUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
5.18 FileDownload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
5.19 ScreenLayoutusingTiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
5.20 SystemDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
5.21 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414
6 SecurityforTERASOLUNAServerFrameworkforJava(5.x) 1463
6.1 SpringSecurityOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
6.2 SpringSecurityTutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
6.3 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507
6.4 PasswordHashing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
6.5 Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1566
6.6 XSSCountermeasures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1583
6.7 CSRFCountermeasures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1592
7 Appendix 1607
7.1 Tutorial(TodoApplicationREST) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607
7.2 CreateaNewProjectfromBlankProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
7.3 JSPTagLibrariesandELFunctionsofferedbycommonlibrary . . . . . . . . . . . . . . . . . . 1684
7.4 MavenRepositoryManagementusingNEXUS . . . . . . . . . . . . . . . . . . . . . . . . . . . 1697
7.5 RemovingEnvironmentDependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1704
7.6 ProjectStructureStandard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1712
7.7 ReducingBoilerplateCode(Lombok) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715
7.8 ReferenceBooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1728
7.9 SpringFrameworkComprehensionCheck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1729
ii
TERASOLUNAServerFrameworkforJava(5.x)DevelopmentGuidelineDocumentation,
Release5.0.2.RELEASE
Note: If there are any mistakes in the contents or any comments related to the contents, please raise them at
IssuesonGithub.
1

3
1
In the Beginning
1.1 Terms of Use
Inordertousethisdocument,youarerequiredtoagreetoabidebythefollowingterms. Ifyoudonotagreewith
theterms,youmustimmediatelydeleteordestroythisdocumentandallitsduplicatecopies.
1. CopyrightsandallotherrightsofthisdocumentshallbelongtoNTTDATAorthirdpartypossessingsuch
rights.
2. Thisdocumentmaybereproduced, translatedoradapted, inwholeorinpartforpersonaluse. However,
deletionofthetermsgivenonthispageandcopyrightnoticeofNTTDATAisprohibited.
3. This document may be changed, in whole or in part for personal use. Creation of secondary work using
thisdocumentisallowed. However,“Referencedocument: TERASOLUNAServerFrameworkforJava
(5.x) Development Guideline” or equivalent documents may be mentioned in created document and its
duplicatecopies.
4. Document and its duplicate copies created according to Clause 2 may be provided to third party only if
thesearefreeofcost.
5. Use of this document and its duplicate copies, and transfer of rights of this contract to a third party, in
wholeorinpart,beyondtheconditionsspecifiedinthiscontract,areprohibitedwithoutthewrittenconsent
ofNTTData.
6. NTTDATAshallnotbearanyresponsibilityregardingcorrectnessofcontentsofthisdocument,warrantyof
fitnessforusagepurpose,assuranceforaccuracyandreliabilityofusageresult,liabilityfordefectwarranty,
andanydamageincurreddirectlyorindirectly.
7. NTTDATAdoesnotguaranteetheinfringementofcopyrightsandanyotherrightsofthirdpartythrough
thisdocument.Inadditiontothis,NTTDATAshallnotbearanyresponsibilityregardinganyclaim(Includ-
ingtheclaimsoccurredduetodisputewiththirdparty)occurreddirectlyorindirectlyduetoinfringement
ofcopyrightandotherrights.
TERASOLUNAServerFrameworkforJava(5.x)DevelopmentGuidelineDocumentation,
Release5.0.2.RELEASE
Registered trademarks or trademarks of company name and service name, and product name of their respective
companiesusedinthisdocumentareasfollows.
• TERASOLUNAisaregisteredtrademarkofNTTDATACorporation.
• Allothercompanynamesandproductnamesaretheregisteredtrademarksortrademarksoftheirrespective
companies.
4 1 IntheBeginning
TERASOLUNAServerFrameworkforJava(5.x)DevelopmentGuidelineDocumentation,
Release5.0.2.RELEASE
1.2 This document covers the following
ThisguidelineprovidesbestpracticestodevelophighlymaintainableWebapplicationsusingfullstackframework
focussingonSpring,SpringMVCandJPA,MyBatis.
Thisguidelinehelpstoproceedwiththesoftwaredevelopment(mainlycoding)smoothly.
1.3 Target readers of this document
Thisguidelineiswrittenforthearchitectsandprogrammershavingsoftwaredevelopmentexperienceandknowl-
edgeofthefollowing.
• BasicknowledgeofDIandAOPofSpringFramework
• WebdevelopmentexperienceusingServlet/JSP
• KnowledgeofSQL
• ExperienceofbuildingWebApplicationusingMaven
Thisguidelineisnotforbeginners.
In order to check whether the readers have basic knowledge of Spring Framework, refer to Spring Framework
ComprehensionCheck. Itisrecommendedtostudythefollowingbooksifoneisnotabletoanswer40%ofthe
comprehensiontest.
• Spring3入門―Javaフレームワーク・より良い設計とアーキテクチャ（技術評論社）[Japanese]
• ProSpring4thEdition(Apress)
1.4 Structure of this document
•Summary-ArchitectureofTERASOLUNAServerFrameworkforJava(5.x) Overview of Spring
MVCandbasicconceptsofTERASOLUNAServerFrameworkforJava(5.x)isexplained.
•Tutorial(TodoApplication) ExperienceinapplicationdevelopmentusingTERASOLUNAServerFrame-
workforJava(5.x)throughsimpleapplicationdevelopment.
•ApplicationDevelopmentusingTERASOLUNAServerFrameworkforJava(5.x) Knowledge and
methods for application development using TERASOLUNA Server Framework for Java (5.x) are
explained.
•ArchitectureinDetail-TERASOLUNAServerFrameworkforJava(5.x) Method to implement the
functionsrequiredforgeneralapplicationdevelopmentusingTERASOLUNAServerFrameworkfor
Java(5.x)orfeaturesofeachfunctionisexplained.
1.2. Thisdocumentcoversthefollowing 5
TERASOLUNAServerFrameworkforJava(5.x)DevelopmentGuidelineDocumentation,
Release5.0.2.RELEASE
•SecurityforTERASOLUNAServerFrameworkforJava(5.x) Security measures are explained focus-
ingonSpringSecurity.
•Appendix DescribingtheadditionalinformationwhenTERASOLUNAServerFrameworkforJava(5.x)is
beingused.
1.5 Reading this document
Firstlyread“Summary-ArchitectureofTERASOLUNAServerFrameworkforJava(5.x)”.
Implement“FirstapplicationbasedonSpringMVC”forbeginnersofSpringMVC.
Read“ApplicationLayering”astheterminologyandconceptsusedinthisguidelineareexplainedhere.
Thencontinuewith“Tutorial(TodoApplication)”.
GetafeelofapplicationdevelopmentusingTERASOLUNAGlobal
Frameworkbyfirstlytryingitaspertheproverb“Practicemakesperfect”.
Usethistutorialtostudythedetailsofapplicationdevelopmentin“ApplicationDevelopmentusing
TERASOLUNAServerFrameworkforJava(5.x)”.
SincetheknowhowfordevelopmentisexplainedusingSpringMVCin“ImplementationofApplicationLayer”,
itisrecommendedtoreaditagainandagainseveraltimes.
Onecangetabetterunderstandingbystudying“Tutorial(TodoApplication)”onceagainafterreadingthis
chapter.
ItisstronglyrecommendedthatallthedeveloperswhouseTERASOLUNAServerFrameworkforJava
(5.x)readit.
Referto“ArchitectureinDetail-TERASOLUNAServerFrameworkforJava(5.x)”and“Securityfor
TERASOLUNAServerFrameworkforJava(5.x)“
aspertherequirement. However,read“InputValidation”sinceitisnormallyrequiredforapplication
development.
Thetechnicalleaderunderstandsallthecontentsandchecksthetypeofpolicytobedecidedintheproject.
Note: Ifyoudonothavesufficienttime,firstgothroughthefollowing.
1. FirstapplicationbasedonSpringMVC
2. ApplicationLayering
6 1 IntheBeginning