44 |
45 |
53 | ```
54 |
55 | ==== Add New Comment
56 |
57 | The first thing we need to do is to update our add comment form. First, from the controllers perspective we will need to load an empty comment. To do that we will need to modify our read method in our `LinkController`.
58 |
59 | ```java
60 | @GetMapping("/link/{id}")
61 | public String read(@PathVariable Long id,Model model) {
62 | Optional link = linkRepository.findById(id);
63 | if( link.isPresent() ) {
64 | Link currentLink = link.get();
65 | Comment comment = new Comment();
66 | comment.setLink(currentLink);
67 | model.addAttribute("comment",comment);
68 | model.addAttribute("link",currentLink);
69 | model.addAttribute("success", model.containsAttribute("success"));
70 | return "link/view";
71 | } else {
72 | return "redirect:/";
73 | }
74 | }
75 | ```
76 |
77 | Next we will update our add form to contain a little bit more information. We need to add a form action and object. We also need to add a hidden field for the link because this isn't something the user selects.
78 |
79 | ```html
80 |
46 | therealdanvega
47 | 4 hours ago
48 |
52 | It’s one thing I never care about, new releases of maven. Yet I do for most other things.. I really should take a look at any features released in the last while! Pull my dependencies, run my tests and upload to nexus. I don’t care for much else, I wonder what if any I’m missing.
49 | permalink 50 | Like 51 |
81 |
82 |
92 | ```
93 |
94 |
95 | You might think to create a new Comment Controller but we don't actually have to. Comments belong to this particular link so adding a new mapping to handle the post right in our `LinkController` is just fine.
96 |
97 | ```java
98 | @PostMapping("/link/comments")
99 | public String addComment(@Valid Comment comment, BindingResult bindingResult, Model model, RedirectAttributes redirectAttributes) {
100 | if( bindingResult.hasErrors() ) {
101 | logger.info("Something went wrong.");
102 | } else {
103 | logger.info("New Comment Saved!");
104 | commentRepository.save(comment);
105 | }
106 | return "redirect:/link/" + comment.getLink().getId();
107 | }
108 | ```
109 |
--------------------------------------------------------------------------------
/course_sections/_spring-mvc-controller.adoc:
--------------------------------------------------------------------------------
1 | image::mvc.png[]
2 |
3 | ==== Controller Introduction
4 |
5 | We are now into the C in our MVC application. The C stands for controller and you can think of the controller as the traffic cop in our application. The controller handles incoming http requests and "directs traffic". Methods in your controller are mapped to HTTP
6 | by using @RequestingMapping (or one of its composed) annotations.
7 |
8 | ===== @Controller Annotation
9 |
10 | Spring MVC provides an annotation-based programming model where https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/stereotype/Controller.html[@Controller] and https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestController.html[@RestController] components use annotations to express request mappings, request input, exception handling, and more. Annotated controllers have flexible method signatures and do not have to extend base classes nor implement specific interfaces. The following example shows a controller defined by annotations:
11 |
12 | ```java
13 | @Controller
14 | public class HelloController {
15 |
16 | @GetMapping("/hello")
17 | public String handle(Model model) {
18 | model.addAttribute("message", "Hello World!");
19 | return "index";
20 | }
21 | }
22 | ```
23 |
24 | ===== @Controller,@Component, @Service (Stereo-type annotations)
25 |
26 | What are all of the annotations I am seeing at the top of classes. I have seen things `@Component`, `@Controller`, `@RestController`, `@Service` and I just don't understand what they are. Luckily I have already written a pretty good article on how these all work. So if you have a chance please read through the following blog post.
27 |
28 | https://therealdanvega.com/blog/2017/03/27/spring-stereotype-annotations
29 |
30 | ===== @ComponentScan
31 | By default Spring is going to look in your base package for components. If you want to include controllers(components) outside of your base package you need to use https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/context/annotation/ComponentScan.html[@ComponentScan]
32 |
33 | ```java
34 | @SpringBootApplication
35 | @ComponentScan(basePackages = {"com.foo.components"})
36 | public class SpringitApplication {
37 |
38 | private static final Logger log = LoggerFactory.getLogger(SpringitApplication.class);
39 |
40 | public static void main(String[] args) {
41 | SpringApplication.run(SpringitApplication.class, args);
42 | }
43 |
44 | }
45 | ```
46 |
47 |
48 | ==== @Controller vs @RestController
49 |
50 | https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestController.html[@RestController] is a composed annotation that is itself meta-annotated with https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/stereotype/Controller.html[@Controller] and https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RequestBody.html[@ResponseBody] to indicate a controller whose every method inherits the type-level @ResponseBody annotation and, therefore, writes directly to the response body versus view resolution and rendering with an HTML template.
51 |
52 | If you create a templates folder under resources with an index.html file containing the following code you can switch `@RestController` to `@Controller` and see the it in action.
53 |
54 | ```html
55 |
56 |
57 |
58 |
59 |
60 |
61 |
83 |
90 |
91 | Welcome to SpringIt!
66 | 67 | 68 | 69 | ``` 70 | 71 | 72 | ===== @RequestMapping 73 | 74 | You can use the https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html[@RequestMapping] annotation to map requests to controllers methods. It has various attributes to match by URL, HTTP method, request parameters, headers, and media types. You can use it at the class level to express shared mappings or at the method level to narrow down to a specific endpoint mapping. 75 | 76 | ```java 77 | @RequestMapping( path = "/", method = RequestMethod.GET, consumes = "application/json", produces = "application.json") 78 | public String home(){ 79 | return "Hello, Spring Boot 2!"; 80 | } 81 | ``` 82 | 83 | There are also HTTP method specific shortcut variants of @RequestMapping: 84 | 85 | * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/GetMapping.html[@GetMapping] 86 | * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/PostMapping.html[@PostMapping] 87 | * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/PutMapping.html[@PutMapping] 88 | * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/DeleteMapping.html[@DeleteMapping] 89 | * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/PatchMapping.html[@PatchMapping] 90 | 91 | 92 | ===== Handler Methods 93 | 94 | @RequestMapping handler methods have a flexible signature and can choose from a range of supported controller method arguments and return values. I have included a link 95 | to the documentation that covers all of the available handler method arguments. 96 | 97 | https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-methods 98 | 99 | 100 | ==== Link Controller 101 | 102 | Now that we know a little bit more about controllers and what methods are available to us we should be able to start building out the basic parts of our Link Controller. Create a new class in the controller package called `LinkController.java`. We are going to start with some stub methods and discuss a few things about how to start implementing them. 103 | 104 | 105 | ```java 106 | @RestController 107 | public class LinkController { 108 | 109 | // list 110 | public List list() { 111 | return null; 112 | } 113 | 114 | // CRUD 115 | public Link create() { 116 | return null; 117 | } 118 | public Link read() { 119 | return null; 120 | } 121 | public Link update() { 122 | return null; 123 | } 124 | public void delete() { 125 | 126 | } 127 | } 128 | ``` 129 | -------------------------------------------------------------------------------- /course_sections/_service.adoc: -------------------------------------------------------------------------------- 1 | 2 | When we started creating our controllers I didn't spend a lot of time on what should go in there because I just wanted us to start writing code. Now that our application has taken shape I want to revisit that. 3 | 4 | Controllers are supposed to be "thin" and shouldn't contain any real business logic. The controllers job is to simply handle the request and move the user into the correct view or return the response in an API call. 5 | 6 | If that's the case then where do we put all of our business logic? The answer is of course in the service layer. As you might have already noticed there is no S in MVC but this is one of those patterns that has become standard over the years. In this section we are going to cover: 7 | 8 | * What is a Service class and what should it contain 9 | * How to create a Service class 10 | * Creating a User Service 11 | * Refactoring our existing controllers 12 | * @Transactional What is it and why do we need it 13 | 14 | The reason we are doing this now is because in the next section we are going to revisit the registration process. There are a lof of things that happen in that process and we need a logical place for that functionality to live. 15 | 16 | IMPORTANT: CREATE NEW BRANCH CALLED service 17 | 18 | ==== User Service 19 | 20 | We are going to start off by creating a User Service in this section. Let's start to think about some of the methods that might go into our User Service. 21 | 22 | * Register 23 | * Save the new user 24 | * Send Activation Email 25 | * Optional
313 |
321 |
322 |
314 |
320 | Spring Boot Reddit Clone
315 |This is a reddit clone built using Spring Boot 2, Spring Framework 5 & so many other great projects! If you would like to learn how to build this 316 | application you can check out my course, Getting Started with Spring Boot 2.
317 | Github Repo 318 | Spring Boot 2 Course 319 |
323 |
325 |
326 |
327 |
328 | ```
329 |
330 | I like to create a new file in this folder as well called new_page.html. This is what a basic starter page will look like.
331 |
332 | ```html
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 | This is your main content
324 |
341 |
343 |
344 |
345 | ```
346 |
347 | ==== Building our Link List Page
348 |
349 | Now that we have our layout it's time to build our first page, our list of links. Before we get started it would be a good idea to have a list of links in our database. I went over to one of my favorite sub reddits https://www.reddit.com/r/springboot[/r/springboot] and just grabbed 11 items for testing.
350 |
351 | To do so I am going to move them into our database loader and remove the bean from the main application class.
352 |
353 | ```java
354 | @Component
355 | public class DatabaseLoader implements CommandLineRunner {
356 |
357 | private LinkRepository linkRepository;
358 | private CommentRepository commentRepository;
359 |
360 | public DatabaseLoader(LinkRepository linkRepository, CommentRepository commentRepository) {
361 | this.linkRepository = linkRepository;
362 | this.commentRepository = commentRepository;
363 | }
364 |
365 | @Override
366 | public void run(String... args) {
367 | MapThis is my content
342 |
475 |
476 |
477 |
503 |
504 |
505 |
506 | ```
507 |
508 | ==== Building our Link View Page
509 |
510 | We already have a working list page and now we need to create a vew page for each link. We will start out by creating a new `@GetMapping` in our `LinkController`.
511 |
512 | ```java
513 | @GetMapping("/link/{id}")
514 | public String read(@PathVariable Long id, Model model) {
515 | return "link/view";
516 | }
517 | ```
518 |
519 | And we will create a new view page. I did this by renaming link to view and using our layout fragments.
520 |
521 | ```html
522 |
523 |
524 |
525 |
526 |
527 |
528 |
529 |
530 |
531 |
478 |
483 |
501 |
502 |
484 |
500 | 485 | 486 | Title Goes Here 487 | 488 | (therealdanvega.com) 489 |
490 |submitted 491 | 492 | by 493 | therealdanvega 494 |
495 |496 | 0 comments 497 | share 498 |
499 |
532 |
533 |
534 |
591 |
592 |
593 |
594 | ```
595 |
596 | We need to get an instance of a link based on the id in the url. What happens if that id is something random though like 999? This is why Spring Data wants to return us an Optional by default. In this case we don't need to do any null checking, we can simply ask the optional if a link is present. If it is we will send it down to our view page, if not we can redirect to our list page.
597 |
598 | ```java
599 | @GetMapping("/link/{id}")
600 | public String read(@PathVariable Long id,Model model) {
601 | Optional link = linkRepository.findById(id);
602 | if( link.isPresent() ) {
603 | model.addAttribute("link",link.get());
604 | model.addAttribute("success", model.containsAttribute("success"));
605 | return "link/view";
606 | } else {
607 | return "redirect:/";
608 | }
609 | }
610 | ```
611 |
612 | ==== Building our Submit Page
613 |
614 | We need to be able to add a new link to our database through the UI. To do so we are going to add a form that allows anyone to enter a title and a URL and submit it. When the submission happens we will perform some validation and if it passes, we will save that link to the database. After the link has been saved we will set a flash attribute and send the user to the view page for that link.
615 |
616 | For this to work we are going to need 2 different handler methods in our controller, one to show the page and one to handle the submission. I am also going to add a logger to our page so I can add some logging information in our methods.
617 |
618 | ```java
619 | private static final Logger logger = LoggerFactory.getLogger(LinkController.class);
620 | ```
621 |
622 | ```java
623 | @GetMapping("/link/submit")
624 | public String newLinkForm(Model model) {
625 | model.addAttribute("link",new Link());
626 | return "link/submit";
627 | }
628 |
629 | @PostMapping("/link/submit")
630 | public String createLink(@Valid Link link, BindingResult bindingResult, Model model, RedirectAttributes redirectAttributes) {
631 | return "link/submit";
632 | }
633 | ```
634 |
635 | This is what our submit page is going to look like. The key part to this page is the `th:object=""` expression. To learn more about Expressions on selections (asterisk syntax) https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#expressions-on-selections-asterisk-syntax[click here].
636 |
637 | ```html
638 |
639 |
640 |
641 |
642 |
643 |
644 |
645 |
646 |
647 |
535 |
540 |
558 |
559 |
560 |
541 |
557 | 542 | 543 | What's new in Spring Boot 2? 544 | 545 | (therealdanvega.com) 546 |
547 |submitted 548 | by 549 | therealdanvega 550 | 551 |
552 |553 | 8 comments 554 | share 555 |
556 |
648 |
649 |
678 |
679 |
680 |
681 |
682 | ```
683 |
684 | ===== Validation
685 |
686 | We perform validation by adding validation rules to our entity objects. We can use rules like
687 |
688 | * @NotNull
689 | * @NotEmpty
690 | * @URL
691 |
692 | There are so many validation rules and these are a part of the https://docs.jboss.org/hibernate/validator/5.1/api/org/hibernate/validator/constraints/package-summary.html[Hibernate Validation Library].
693 |
694 | ===== Link Controller Methods Completed
695 |
696 | If we want to we can add a nice success message to our view page
697 |
698 | ```html
699 |
650 |
651 |
676 |
677 |
652 |
654 | 673 |
674 |
675 | Submit Link
653 |654 | 673 |
700 | Your new link was created!
701 |
702 | ```
703 |
704 | This is what the final controller methods look like.
705 |
706 | ```java
707 | @GetMapping("/link/submit")
708 | public String newLinkForm(Model model) {
709 | model.addAttribute("link",new Link());
710 | return "link/submit";
711 | }
712 |
713 | @PostMapping("/link/submit")
714 | public String createLink(@Valid Link link, BindingResult bindingResult, Model model, RedirectAttributes redirectAttributes) {
715 | if( bindingResult.hasErrors() ) {
716 | logger.info("Validation errors were found while submitting a new link.");
717 | model.addAttribute("link",link);
718 | return "link/submit";
719 | } else {
720 | // save our link
721 | linkRepository.save(link);
722 | logger.info("New Link was saved successfully.");
723 | redirectAttributes
724 | .addAttribute("id", link.getId())
725 | .addFlashAttribute("success",true);
726 | return "redirect:/link/{id}";
727 | }
728 | }
729 | ```
730 |
731 |
--------------------------------------------------------------------------------
/course_sections/_spring-security.adoc:
--------------------------------------------------------------------------------
1 | image::spring-security.jpeg[]
2 |
3 | ==== Spring Security Introduction
4 |
5 | IMPORTANT: CREATE NEW BRANCH CALLED spring-security
6 |
7 | In this lesson we are going to discuss a very important topic and that is security. It turns out that Security is really hard and it isn't something that we want to build ourselves. Luckily for us the Spring Security project is the standard for securing Spring based applications and it is really good at it.
8 |
9 | There were some important changes in Spring Boot 2 & Spring Security 5 so we are going to dive right into those. In this section we will start by adding the spring boot security starter that will bring in most of everything we will need and from there we will gradually build on that until we have what we need to move forward.
10 |
11 | ===== What is Spring Security?
12 |
13 | Spring Security is a powerful and highly customizable authentication and access-control framework. It is the de-facto standard for securing Spring-based applications.
14 |
15 | Spring Security is a framework that focuses on providing both authentication and authorization to Java applications. Like all Spring projects, the real power of Spring Security is found in how easily it can be extended to meet custom requirements
16 |
17 | **Features**
18 |
19 | * Comprehensive and extensible support for both Authentication and Authorization
20 | * Protection against attacks like session fixation, clickjacking, cross site request forgery, etc
21 | * Servlet API integration
22 | * Optional integration with Spring Web MVC
23 | * Much more…
24 |
25 | ===== What's new in Spring Boot 2.0
26 |
27 | https://spring.io/blog/2017/09/15/security-changes-in-spring-boot-2-0-m4
28 |
29 | ===== Getting Started
30 |
31 | To get started with Spring Security you can select it in the Spring Initializer or you can just include the Spring Boot Starter Security.
32 |
33 | ```
34 |
573 |
574 |
575 |
637 |
638 |
639 |
640 |
641 |
642 | ```
643 |
644 | IMPORTANT: We turned off CSRF earlier for the H2 Console to work. We want this on, enable it and read more about it here https://docs.spring.io/spring-security/site/docs/current/reference/html/web-app-security.html#csrf-configure
645 |
646 | ===== Username & Password Form Parameters
647 |
648 | There is just one more step to do to make this all work. I bet you're probably thinking that we need to create a handler method for our login submit but we actually don't have to. Spring Security handles all of that for us. When we submit a form Spring Security is expecting 2 things from us:
649 |
650 | * The username must be present as the HTTP parameter named username
651 | * The password must be present as the HTTP parameter named password
652 |
653 | Since our field is named "email" we just need to add one more configuration to our form login and that is `usernameParameter("email")`
654 |
655 | ```java
656 | @Override
657 | protected void configure(HttpSecurity http) throws Exception {
658 | http
659 | .authorizeRequests()
660 | .requestMatchers(EndpointRequest.to("info")).permitAll()
661 | .requestMatchers(EndpointRequest.toAnyEndpoint()).hasRole("ACTUATOR")
662 | .antMatchers("/actuator/").hasRole("ACTUATOR")
663 | .antMatchers("/link/submit").hasRole("USER")
664 | .antMatchers("/link/**").permitAll()
665 | .antMatchers("/").permitAll()
666 | .antMatchers("/h2-console/**").permitAll()
667 | .and()
668 | .formLogin()
669 | .loginPage("/login").permitAll()
670 | .usernameParameter("email");
671 | }
672 | ```
673 |
674 | ===== Form Logout
675 |
676 | When using the WebSecurityConfigurerAdapter, logout capabilities are automatically applied. The default is that accessing the URL /logout will log the user out by:
677 |
678 | * Invalidating the HTTP Session
679 | * Cleaning up any RememberMe authentication that was configured
680 | * Clearing the SecurityContextHolder
681 | * Redirect to /login?logout
682 | * Similar to configuring login capabilities, however, you also have various options to further customize your logout requirements:
683 |
684 |
685 |
686 | If you wanted to you could further customize the logout experience
687 |
688 | ```java
689 | protected void configure(HttpSecurity http) throws Exception {
690 | http
691 | .logout()
692 | .logoutUrl("/my/logout")
693 | .logoutSuccessUrl("/my/index")
694 | .logoutSuccessHandler(logoutSuccessHandler)
695 | .invalidateHttpSession(true)
696 | .addLogoutHandler(logoutHandler)
697 | .deleteCookies(cookieNamesToClear)
698 | .and()
699 | ...
700 | }
701 | ```
702 |
703 | If you get a logout 404 error this is why https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#csrf-logout
704 |
705 | image::logout_404.png[]
706 |
707 | I updated our main_layout to use a POST instead of a GET
708 |
709 | ```html
710 |
775 | This content is only shown to authenticated users.
776 |
777 |
778 | This content is only shown to administrators.
779 |
780 |
781 | This content is only shown to users.
782 |
783 | ```
784 |
785 | The sec:authentication attribute is used to print logged user name and roles:
786 |
787 | ```html
788 | Logged user: Bob
789 | Roles: [ROLE_USER, ROLE_ADMIN]
790 | ```
791 |
792 | ===== Getting Started
793 |
794 | This is one of the first dependencies that we will come across that isn't in the Spring Initializer and will need to be added manually. It also worth pointing out that this isn't officially a part of the Thymeleaf project.
795 |
796 | ```
797 | submitted 859 | by 860 | therealdanvega 861 |
862 | ``` 863 | 864 | Then we also need to update this in the view link. 865 | 866 | ```html 867 |submitted 868 | by 869 | therealdanvega 870 | 871 |
872 | ``` 873 | 874 | Again not ideal because its showing the email address but for simplicity sake we will keep it for now. 875 | 876 | ==== Account & Registration 877 | 878 | When we updated the links in the navbar I added some routes to them. The account link goes to `/profile` and the Register link goes to `/register`. 879 | 880 | ```html 881 |
919 |
920 |
1039 |
1040 |
1041 |
1042 | ```
1043 |
1044 | ```html
1045 |
1046 |
1047 |
1048 |
1049 |
1050 |
1051 |
1052 |
1053 |
1054 |
1148 |
1149 |
1150 |
1151 | ```
1152 |
1153 |
1154 |
1155 |
--------------------------------------------------------------------------------
921 |
935 |
936 |
937 |
938 |
939 |
1037 |
1038 |
940 |
996 |
997 |
941 |
951 |
942 |
950 |
943 |
949 | What's new in Spring Boot 2
944 |submitted 7 days ago by therealdanvega
945 |Some quick example text to build on the card title and make up the bulk of the card's content.
946 | 8 Comments 947 | Share 948 |
952 |
962 |
953 |
961 |
954 |
960 | What's new in Spring Boot 2
955 |submitted 7 days ago by therealdanvega
956 |Some quick example text to build on the card title and make up the bulk of the card's content.
957 | 8 Comments 958 | Share 959 |
963 |
973 |
964 |
972 |
965 |
971 | What's new in Spring Boot 2
966 |submitted 7 days ago by therealdanvega
967 |Some quick example text to build on the card title and make up the bulk of the card's content.
968 | 8 Comments 969 | Share 970 |
974 |
984 |
975 |
983 |
976 |
982 | What's new in Spring Boot 2
977 |submitted 7 days ago by therealdanvega
978 |Some quick example text to build on the card title and make up the bulk of the card's content.
979 | 8 Comments 980 | Share 981 |
985 |
995 |
986 |
994 |
987 |
993 | What's new in Spring Boot 2
988 |submitted 7 days ago by therealdanvega
989 |Some quick example text to build on the card title and make up the bulk of the card's content.
990 | 8 Comments 991 | Share 992 |
998 |
1035 |
1036 |
999 |
1009 |
1000 | ![Card image cap]()
1001 |
1008 |
1002 |
1007 | 1003 | /u/therealdanvega 1004 |
1005 | 1006 |
1010 |
1022 |
1011 |
1012 |
1021 |
1013 |
1020 | Your Information
1014 |
1015 | Posts: 10
1016 | Comments: 3
1017 | User Since: November 23, 2017
1018 |
1023 |
1034 |
1024 |
1033 | Recent Links Clicked
1025 |-
1026 |
- What's new in Spring Boot 2 1027 |
- 10 Features in Java 10 1028 |
- 9 Features in Java 9 1029 |
- 8 Features in Java 8 1030 |
- 7 Reasons not to use Java 7 1031 |
It’s one thing I never care about, new releases of maven. Yet I do for most other things.. I really should take a look at any features released in the last while! Pull my dependencies, run my tests and upload to nexus. I don’t care for much else, I wonder what if any I’m missing.
583 | permalink 584 | Like 585 |