\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{danielfc} \pdfinfo{ /Title (spring-framework-4.pdf) /Creator (Cheatography) /Author (danielfc) /Subject (Spring Framework 4 Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{6DB33F} \definecolor{LightBackground}{HTML}{F5FAF3} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Spring Framework 4 Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{danielfc} via \textcolor{DarkBackground}{\uline{cheatography.com/24913/cs/6341/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}danielfc \\ \uline{cheatography.com/danielfc} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 9th December, 2015.\\ Updated 12th December, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Modules}} \tn % Row 0 \SetRowColor{LightBackground} Core & \{\{nobreak\}\}spring-core \{\{nl\}\} spring-beans \{\{nl\}\} spring-context \{\{nl\}\} spring-expression \tn % Row Count 5 (+ 5) % Row 1 \SetRowColor{white} \{\{nobreak\}\} AOP and Instrumentation & \{\{nobreak\}\}spring-aop \{\{nl\}\}spring-aspects \{\{nl\}\} spring-instrument \{\{nl\}\} \seqsplit{spring-instrument-tomcat} \tn % Row Count 10 (+ 5) % Row 2 \SetRowColor{LightBackground} Messaging & spring-messaging \tn % Row Count 11 (+ 1) % Row 3 \SetRowColor{white} Data \seqsplit{Access/Integration} & \{\{nobreak\}\}spring-jdbc \{\{nl\}\}spring-tx \{\{nl\}\}spring-orm\{\{nl\}\}spring-oxm\{\{nl\}\}spring-jms \tn % Row Count 16 (+ 5) % Row 4 \SetRowColor{LightBackground} Web & \{\{nobreak\}\}spring-web \{\{nl\}\} spring-webmvc \{\{nl\}\}spring-webmvc-portlet \{\{nl\}\}spring-websocket \{\{nl\}\} \tn % Row Count 21 (+ 5) % Row 5 \SetRowColor{white} Test & spring-test \tn % Row Count 22 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/overview.html\#overview-modules}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.12 cm} x{4.88 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Spring MVC - Controller}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}@Controller & Annotation to indicate that the class is a controller class. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \{\{nobreak\}\}@RestController & A convenience annotation that is itself annotated with `@Controller` and `@ResponseBody`. Used in controllers that will behave as {\bf{RESTful resources}}. \tn % Row Count 10 (+ 7) % Row 2 \SetRowColor{LightBackground} \{\{nobreak\}\}@RequestMapping & Annotation to be used on methods in `@RestController` classes. You can provide an {\bf{URI}} to be served as {\bf{RESTful service}}. \tn % Row Count 16 (+ 6) % Row 3 \SetRowColor{white} \{\{nobreak\}\}@ModelAttribute & Annotation used to bind values present in views. \tn % Row Count 18 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.04 cm} x{4.96 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Configuration}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}@Configuration & Annotation used to provide {\bf{configurations}}. \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} @Bean & Annotation that acts like a {\bf{provider}} where you can define {\bf{how}} the bean is {\bf{instantiated}} when a {\bf{injection}} of that type is requested. Instances of `@Bean` annotated methods will act as {\bf{singletons}}. \tn % Row Count 11 (+ 9) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.68 cm} x{4.32 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Properties Evaluation Sequence}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}Command-line arguments & `java -Dproject.name=Test -jar app.jar` \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} System properties & \seqsplit{`System.getProperties()`} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} Environment Variable & `export PROJECT\_NAME=Test` \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} External properties/yml file & `project.name=Test` \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} Internal properties/yml file & `project.name=Test` \tn % Row Count 10 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{The default properties/yml files are {\bf{application.properties}} and {\bf{application.yml}} and they are located in `/src/resources`.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.6 cm} x{4.4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Spring Boot Initializer}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}http://start.spring.io & Web service that allows the user to specify the project metadata and dependencies as well as download the initial structure. \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} Spring CLI & A CLI tool that interacts with {\bf{http://start.spring.io}} service to scaffold a new project. \tn % Row Count 11 (+ 5) % Row 2 \SetRowColor{LightBackground} Spring Tool Suit & Eclipse-based IDE that also interacts with {\bf{http://start.spring.io}} to scaffold a new project. \tn % Row Count 16 (+ 5) % Row 3 \SetRowColor{white} Intellij IDEA & Intellij also provides a way of creating a new project via {\bf{http://start.spring.io}}. \tn % Row Count 20 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.204 cm} x{2.736 cm} x{2.66 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{8.4cm}}{\bf\textcolor{white}{Spring Boot - Auto Configuration}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}@ConditionalOnClass & \seqsplit{`@ConditionalOnClass(Tomcat}.class)` & Only available if the Tomcat class is found in the classpath. \tn % Row Count 5 (+ 5) % Row 1 \SetRowColor{white} \{\{nobreak\}\}@ConditionalOnProperty & \seqsplit{`@ConditionalOnProperty(name} = \seqsplit{"tomcat.version"}, \seqsplit{matchIfMissing} = true)` & Only available if the property \seqsplit{`tomcat.version`} is set to true. \tn % Row Count 11 (+ 6) \hhline{>{\arrayrulecolor{DarkBackground}}---} \SetRowColor{LightBackground} \mymulticolumn{3}{x{8.4cm}}{Auto configuration is just the combination of `@Configuration` and `@Conditional*` annotations in order to correctly register beans.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Architecture}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{p{8.4cm}}{\vspace{1px}\centerline{\includegraphics[width=5.1cm]{/web/www.cheatography.com/public/uploads/danielfc_1449688618_Screenshot from 2015-12-09 17:16:50.png}}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{1.76 cm} x{6.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Dependency Injection}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{@Resource} & Annotation used to {\bf{inject}} an object that is already in the {\bf{Application Context}}. It searches the instance {\bf{by name}}. It also works on setter methods. \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} \seqsplit{@Autowired} & Annotation used to {\bf{inject}} objects in many possible ways, such as: {\bf{instance variable, constructor and methods}}. It {\bf{does not rely on name}} as `@Resource`, so, for multiple concrete implementations, the `@Qualifier` annotation must be used with it. \tn % Row Count 15 (+ 9) % Row 2 \SetRowColor{LightBackground} \seqsplit{@Qualifier} & Annotation used to {\bf{distinguish}} between {\bf{multiple}} concrete implementations. Used alongside with `@Autowired` annotation that does not rely on name. \tn % Row Count 20 (+ 5) % Row 3 \SetRowColor{white} \seqsplit{@Primary} & Annotation used when {\bf{no name}} is provided telling {\emph{Spring}} to {\bf{inject}} an object of the annotated class {\bf{first}}. Used along with `@Component`. \tn % Row Count 25 (+ 5) % Row 4 \SetRowColor{LightBackground} \seqsplit{@Component} & Generic stereotype annotation used to tell {\emph{Spring}} to {\bf{create an instance}} of the object in the {\bf{Application Context}}. It's possible to define any {\bf{name}} for the instance, the default is the class name as {\bf{camel case}}. \tn % Row Count 33 (+ 8) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{1.76 cm} x{6.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Dependency Injection (cont)}} \tn % Row 5 \SetRowColor{LightBackground} \seqsplit{@Controller} & Stereotype annotation for presentation layer. \tn % Row Count 2 (+ 2) % Row 6 \SetRowColor{white} \seqsplit{@Repository} & Stereotype annotation for persistence layer. \tn % Row Count 4 (+ 2) % Row 7 \SetRowColor{LightBackground} \seqsplit{@Service} & Stereotype annotation for service layer. \tn % Row Count 6 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.6 cm} x{4.4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Profile}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}spring.profiles.active & Property to be set in {\bf{application.properties}} in order to tell {\emph{Spring}} what profiles are active. \tn % Row Count 5 (+ 5) % Row 1 \SetRowColor{white} \{\{nobreak\}\}@Profile("!dev") & Annotation used to define which profile {\bf{can execute}} the annotated method. \tn % Row Count 9 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Spring Boot - Basics}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}@SpringBootApplication & Initial annotation that comprises the following annotations: \seqsplit{`@SpringBootConfiguration`}, \seqsplit{`@EnableAutoConfiguration`} and `@ComponentScan`. \tn % Row Count 7 (+ 7) % Row 1 \SetRowColor{white} \seqsplit{@SpringBootConfiguration} & Indicates that a class provides Spring Boot application `@Configuration`. \tn % Row Count 11 (+ 4) % Row 2 \SetRowColor{LightBackground} \seqsplit{@EnableAutoConfiguration} & Enable auto-configuration of the Spring Application Context, attempting to guess and configure beans that you are likely to need. \tn % Row Count 18 (+ 7) % Row 3 \SetRowColor{white} @ComponentScan & Configures component scanning directives for use with `@Configuration` classes. \tn % Row Count 22 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Most of the time you will need only to declare the `@SpringBootApplication` annotation.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Spring Boot - Example}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{p{8.4cm}}{\vspace{1px}\centerline{\includegraphics[width=5.1cm]{/web/www.cheatography.com/public/uploads/danielfc_1481562232_springb.png}}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}