SpringBoot -01

秒速五厘米 2024-04-06 14:57 77阅读 0赞

#### SpringBoot ####

*  学习目标
 *  1.Spring框架发展史
 *  2.Spring 5.X 应用零配置开发
 *   *   *  注解
         *  实例1-Ioc中Bean的实例化与获取
         *   *   *  @Bean注解使用
 *  3. Spring Boot快速入门
 *   *   *  创建Maven 普通项目
         *  Spring Boot 核心配置
         *   *   *  自定义Banner与Banner关闭
                 *  Spring Boot 配置文件
                 *  项目中日志信息输出
         *  Freemarker & Thymeleaf视图技术集成
         *   *  Freemarker 视图集成
             *  Thymeleaf视图集成
         *  总结

## 学习目标 ##

--------------------

![在这里插入图片描述][c6bb5155c47843a6b23c579f60638f24.png]

## 1.Spring框架发展史 ##

Spring1.x 时代
    在Spring1.x时代，都是通过xml文件配置bean，随着项目的不断扩大，需要将xml配置分放到不同的配置文件中，需要频繁的在java类和xml配置文件中切换。
    
    Spring2.x时代
    随着JDK 1.5带来的注解支持，Spring2.x可以使用注解对Bean进行申明和注入，大大的减少了xml配置
    文件，同时也大大简化了项目的开发。
    那么，问题来了，究竟是应该使用xml还是注解呢？
    最佳实践：
    1. 应用的基本配置用xml，比如：数据源、资源文件等；
    2. 业务开发用注解，比如：Service中注入bean等；
    
    Spring3.x到Spring4.x再到Spring5.x
    从Spring3.x开始提供了Java配置方式，使用Java配置方式可以更好的理解你配置的Bean，现在我们就处
    于这个时代，并且Spring4.x、Spring5.x和Spring Boot都推荐使用java配置的方式。

## 2.Spring 5.X 应用零配置开发 ##

#### 注解 ####

1.  声明Bean 注解

@Component:组件 没有明确规定其角色，作用在类级别上声明当前类为一个业务组件，被Spring Ioc 容器维护;
    @Service:在业务逻辑层（Service 层）类级别进行声明;
    @Repository:在数据访问层(dao 层) 类级别声明;
    @Controller:在展现层(MVC) 使用 标注当前类为一个控制器

1.  注入Bean 注解

@AutoWired:Spring 官方提供注解
    @Inject:JSR-330 提供注解（标准制定方）
    @Resource:JSR-250 提供注解

1.  Spring5.x 中配置与获取Bean注解

@Configuration:作用与类上，将当前类声明为一个配置类，相当于一个xml 配置文件
     @ComponentScan:自动扫描指定包下标注有@Repository,@Service,@Controller
     @Component:注解的类并由Ioc 容器进行实例化和维护
     @Bean::作用于方法上,相当于xml 文件中<bean> 声明当前方法返回值为一个bean
     @Value:获取properties 文件指定key value值

#### 实例1-Ioc中Bean的实例化与获取 ####

1.  创建Spring 普通工程并添加坐标相关配置

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.2.4.RELEASE</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>utf-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

1.  创建UserDao ,UserService Bean 对象

// UserDao.java
    @Repository
    public class UserDao {
        
        public  void test(){
        
            System.out.println("UserDao.test...");
       }
    }
    // UserService.java
    @Service
    public class UserService {
        
        @Resource
        private UserDao userDao;
        public  void test(){
        
            System.out.println("UserService.test...");
            userDao.test();
       }
    }

1.  创建IocConfig配置类

// Ioc 容器配置 Java 代码实现
    @Configuration //声明当前类是一个配置类，相当于xml配置文件
    @ComponentScan("com.xxxx")  //扫描器
    public class IocConfig {
        
    }

1.  创建启动类执行测试

public class Starter {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext ac=new
    AnnotationConfigApplicationContext(IocConfig.class);
           //得到被实例化的对象
            UserService userService= ac.getBean(UserService.class);
            userService.test();
       }
    }

此时启动Spring Ioc 容器通过实例化AnnotationConfigApplicationContext类，接收配置参数类
    IocConfig,并获取UserService Bean 实现方法调用,此时应用环境不存在xml配置文件，简化了应用的
    xml 配置。

结果如下：  
![在这里插入图片描述][c7abdbf8a6f540fdb80cea222d153b55.png]

###### @Bean注解使用 ######

1.  定义AccountDao 对象,并交给Spring Ioc 容器进行实例化

// 注意 此时类级别并未添加 @Repository 注解
    public class AccountDao {
        
        public  void test(){
        
            System.out.println("AccountDao.test...");
       }
    }

1.  修改IocConfig 配置类中添加返回AccountDao Bean对象方法

@Configuration
    @ComponentScan("com.xxxx")
    public class IocConfig {
        
        // 返回实例化的单例Bean对象
        @Bean
        public AccountDao accountDao(){
        
            return new AccountDao();
       }
    }

1.  UserService 中注入AccountDao 对象

@Service
    public class UserService {
        
        @Resource
        private UserDao userDao;
        @Resource
        private AccountDao accountDao;
        public  void test(){
        
            System.out.println("UserService.test...");
            userDao.test();
            accountDao.test();
       }
    }

1.  执行测试

public class Starter {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext ac=new
    AnnotationConfigApplicationContext(IocConfig.class);
            UserService userService= ac.getBean(UserService.class);
            userService.test();
            System.out.println(ac.isSingleton("accountDao"));
       }
    }

## 3. Spring Boot快速入门 ##

框架特点
    创建独立Spring应用程序、嵌入式Tomcat，Jetty容器、无需部署WAR包、简化Maven及Gradle配置、
    尽可能自动化配置Spring、直接植入产品环境下的实用功能，比如度量指标、健康检查及扩展配置、无
    需代码生成及XML配置等，同时Spring Boot不仅对web应用程序做了简化，还提供一系列的依赖包来把
    其它一些工作做成开箱即用。

环境:Idea、Maven、Jdk 1.8+ 、Spring Boot 2.x

#### 创建Maven 普通项目 ####

通过Maven创建一个普通的java项目

1.  添加依赖坐标

<parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>2.2.2.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

*  Spring Boot的项目必须要将parent设置为Spring Boot的parent，该parent包含了大量默认的配置，简  
    化程序的开发。

1.  可以导入Spring Boot的web坐标与相关插件

<plugin>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>

1.  添加源代码

@Controller
    public class HelloController {
        
        @RequestMapping("hello")
        @ResponseBody
        public  String hello(){
        
            return "Hello Spring Boot";
       }
    }

1.  创建启动程序  
    在HelloController.java 所在包下创建StarterApplication.java

@SpringBootApplication
    public class StarterApplication
    {
        
        public static void main(String[] args) {
        
            SpringApplication.run(Starter.class);
       }
    }

1.  启动Spring Boot应用并测试  
    这里运行main 方法即可 通过浏览器访问localhost:8080/hello 效果如下:  
    ![在这里插入图片描述][53395d621bd345f486568005412c1d6a.png]

#### Spring Boot 核心配置 ####

###### 自定义Banner与Banner关闭 ######

![在这里插入图片描述][460ddce9059f46ab9caabca67cf88c64.png]

在搭建Spring Boot项目环境时，程序启动后会在控制台打印醒目的SpringBoot图标,图标描述了Spring
    Boot 版本信息，这是Spring Boot项目与Spring项目启动区别较大的地方，Spring Boot通过默认
    Banner在程序启动时显示应用启动图标，当然图标我们也可以进行自定义。

**Banner图标自定义**

1. Spring Boot项目启动时默认加载src/main/resources 目录下的banner.txt 图标文件,如果该目录文件未
    提供,则使用Spring Boot 默认图标打印
    2. 如果想修改图标：在main 目录下新建resources 资源目录,并在该目录下新建banner.txt 文本文件。

打开网址：[http://patorjk.com/software/taag/\#p=display&f=Graffiti&t=Type%20][http_patorjk.com_software_taag_p_display_f_Graffiti_t_Type_20]

在线生成图标对应文本并将文本内容copy 到banner.txt 中  
![在这里插入图片描述][a077e047d58c4ea0903ba47a5d16e264.png]  
![在这里插入图片描述][cae344c6e38940ef802f33bf8249845c.png]  
控制台：  
![在这里插入图片描述][0232bf0ccc8b4ccda4ed313f74f315e6.png]  
**Banner 图标关闭**

如果启动时不想要看到启动图标 ，这里也可以通过代码进行关闭操作,修改StarterApplication 设置
    BannerMode值为Banner.Mode.OFF,启动Spring Boot 应用关闭图标输出功能即可

@SpringBootApplication
    public class StarterApplication {
        
        public static void main(String[] args) {
        
            SpringApplication springApplication=new
    SpringApplication(StarterApplication .class);
            // 设置banner 图标关闭
            springApplication.setBannerMode(Banner.Mode.OFF);
            springApplication.run();
       }
    }

###### Spring Boot 配置文件 ######

1. Spring Boot 默认会读取全局配置文件，配置文件名固定为:application.properties或application.yml，
    2. 放置在src/main/resources资源目录下,使用配置文件来修改SpringBoot自动配置的默认值；

在resources 资源目录下添加application.properties 文件,配置信息如下:

## 项目启动端口号配置
    server.port=8989
    ## 项目访问上下文路径
    server.servlet-path=/mvc
    ## 数据源配置
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/hr?
    useUnicode=true&characterEncoding=utf8
    spring.datasource.username=root
    spring.datasource.password=root

或者application.yml 文件（对齐表示同一个级别，一定要对齐）

## 端口号 上下文路径
    server:
     port: 8989
     servlet:
       context-path: /mvc
    ## 数据源配置
    spring:
     datasource:
       type: com.mchange.v2.c3p0.ComboPooledDataSource
       driver-class-name: com.mysql.cj.jdbc.Driver
       url: jdbc:mysql://127.0.0.1:3306/hr
       username: root
       password: root

YML语法

![在这里插入图片描述][10929bdc224a453aac0f00ed649c1205.png]

###### 项目中日志信息输出 ######

1. 在开发企业项目时，日志的输出对于系统bug 定位无疑是一种比较有效的方式，也是项目后续进入生产
    环境后快速发现错误解决错误的一种有效手段，所以日志的使用对于项目也是比较重要的一块功能。
    2. Spring Boot项目一般都会引用 spring-boot-starter 或者 spring-boot-starter-web ，而
    这两个起步依赖中都已经包含了对于 spring-boot-starter-logging 的依赖，所以，无需额外添加依
    赖。

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    @SpringBootApplication
    public class Starter {
        
        private static Logger logger = LoggerFactory.getLogger(Starter.class);
        public static void main(String[] args) {
        
            logger.info("SpringBoot 应用开始启动...");
            SpringApplication.run(Starter.class);
       }
    }

#### Freemarker & Thymeleaf视图技术集成 ####

##### Freemarker 视图集成 #####

SpringBoot内部支持Freemarker 视图技术的集成，并提供了自动化配置类
    FreeMarkerAutoConfiguration，借助自动化配置可以很方便的集成Freemarker基础到SpringBoot环
    境中。这里借助入门项目引入Freemarker环境配置。

*  starter坐标引入

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>

*  修改application.yml 添加freemarker 基本配置如下:

spring:
     freemarker:
     //设置视图后缀
       suffix: .ftl
       //设置响应类型
       content-type: text/html
       charset: UTF-8
       //默认的加载路径
       template-loader-path: classpath:/views/

![在这里插入图片描述][d3e7937164074bb8bc5575c516af2ace.png]

*  编写IndexController 控制器转发视图

import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    @Controller
    public class IndexController {
        
        @RequestMapping("index")
        public String index(){
        
            return "index";
       }
    }

*  views目录下添加index.ftl视图  
    ![在这里插入图片描述][406659e622bf495d9e23fc1d6667c5f1.png]  
    ![在这里插入图片描述][b508e0f3a65145c5bb0a6e1e0041978b.png]

##### Thymeleaf视图集成 #####

SpringBoot 支持多种视图技术集成,并且SpringBoot 官网推荐使用Thymeleaf 作为前端视图页面，这里
    实现Thymeleaf 视图集成，借助入门项目引入Thymeleaf 环境配置。

*  starter坐标引入

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

*  添加Thymeleaf 配置信息  
    Thymeleaf 默认默认视图路径文 resources/templates 目录(由自动化配置类  
    FreemarkerProperties 类决定)，该目录可以进行在application.yml 中进行修改。  
    ![在这里插入图片描述][29e502bba93949d496782b295821fd6c.png]

## 环境选择配置
    spring:
     thymeleaf:
       prefix: classpath:/html/
        ## 关闭thymeleaf 页面缓存
       cache: false

*  编写IndexController 控制器转发视图

@Controller
    public class IndexController {
        
        @RequestMapping("index")
        public String index(Model model){
        
            model.addAttribute("msg","hello SpringBoot ");
            return "index";
       }
    }

*  html目录下添加index.html视图  
    修改Thymeleaf模板默认存放路径(在resources 目录下创建html文件夹)

<!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
       <h1 th:text="${msg}"></h1>
    </body>
    </html>

*  启动Starter访问  
    ![在这里插入图片描述][5296ebff7c664831906e59f0243a4933.png]

#### 总结 ####

SpringBoot引入的全新的Starter坐标简化了
    原有坐标的引入方式，借助SpringBoot的自动化配置让开发者面更加专注业务本身的开发，而不是花费
    大量的时间来解决配置的问题，同时SpringBoot还提供了便捷的环境切换操作，做到不同环境方便快捷
    的切换，在开发web项目中遇到的视图整合与静态文件的访问操作，更多要归功于SpringBoot本身
    Starter坐标与自动化配置功能。

[c6bb5155c47843a6b23c579f60638f24.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/caf80f19490343049ed49039bc14ede5.png
[c7abdbf8a6f540fdb80cea222d153b55.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/491db0deae0744a9b73a3561eee0f0f4.png
[53395d621bd345f486568005412c1d6a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/59ce01ab8df84bb9bc45a22cb0794a99.png
[460ddce9059f46ab9caabca67cf88c64.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/9cdfec7b44c044b1ab58634b75e085e3.png
[http_patorjk.com_software_taag_p_display_f_Graffiti_t_Type_20]: http://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type%20Something
[a077e047d58c4ea0903ba47a5d16e264.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/aec0e2c7c9ef423fbafc028e57e8c408.png
[cae344c6e38940ef802f33bf8249845c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/5e713bb7f205441d817e4bddd5d8083c.png
[0232bf0ccc8b4ccda4ed313f74f315e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4073d910417249b6b7f58dc6fd23a898.png
[10929bdc224a453aac0f00ed649c1205.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/c482394311744c8cad578f312a85182f.png
[d3e7937164074bb8bc5575c516af2ace.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4ab984ca3cb9497fa746fcaa6b8258e4.png
[406659e622bf495d9e23fc1d6667c5f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b4c354d9e6e647919abbaae6a1556eb0.png
[b508e0f3a65145c5bb0a6e1e0041978b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/a23dc963c9724f3fa2e7935a5ece44dd.png
[29e502bba93949d496782b295821fd6c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/f7bcbbd389a046c488770f565d5e7fbb.png
[5296ebff7c664831906e59f0243a4933.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/5d717ceadb274610b06256c3783cdfb3.png