Idea工具中创建 SpringBoot工程及入门详解

时间:2022-08-26 20:48:51

SpringBoot 项目创建

 

创建Module

基于IDEA创建项目Module,模块名为04-springboot-start,组id和包名为com.cy,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

填写module信息,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

选择项目module版本,暂时不需要自己手动添加任何依赖,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

填写Module名称,完成module创建,如图所示

Idea工具中创建 SpringBoot工程及入门详解

项目结构分析

项目Module创建好以后,其代码结构分析,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

SpringBoot 项目启动分析

 

启动入口

SpringBoot 工程中由SpringBootApplication注解描述的类为启动入口类,例如:

  1. package com.cy;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class Application {//Application.class
  6. public static void main(String[] args) {//Main Thread
  7. SpringApplication.run(Application.class, args);
  8. }
  9. }

启动过程概要分析

SpringBoot工程启动时其简易初始化过程,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

在启动过程中底层做了哪些事情,大致描述如下:

1)基于配置加载类(通过ClassLoader将指定位置的类读到内存->底层通过线程调用IO从磁盘读取到内存)。

2)对类进行分析(创建字节码对象-Class类型,通过反射获取器配置信息)。

3)对于指定配置(例如由spring特定注解描述)的对象存储其配置信息(借助BeanDefinition对象存储)。

4)基于BeanDefinition对象中class的配置构建类的实例(Bean对象),并进行bean对象的管理(可能会存储到bean池)。

SpringBoot 快速入门分析

 

业务描述

在项目Module中定义一个类,类名为DefaultCache,然后将此类对象交给Spring创建并管理。最后通过单元测试对类的实例进行分析。

API设计分析

基于业务描述,进行API及关系设计,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

代码编写及运行

基于业务及API设计,进行代码编写,其过程如下:

第一步:定义DefaultCache类

  1. package com.cy.pj.common.cache;
  2. import org.springframework.stereotype.Component;
  3. /**
  4. * @Component 注解描述的类,表示此类交给Spring框架管理。
  5. */
  6. @Component
  7. public class DefaultCache {
  8. }

第二步:定义DefaultCacheTests单元测试类

  1. package com.cy.pj.common.cache;
  2. import org.junit.jupiter.api.Test;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. @SpringBootTest
  5. public class DefaultCacheTests {
  6. /**
  7. * @Autowired 注解描述的属性由spring框架按照一定规则为其注入值(赋值)
  8. * 赋值过程是怎样的?
  9. * 1)依赖查找?(请问查找规则是什么?)
  10. * 2)依赖注入?(需要借助什么技术?)
  11. */ @Autowired
  12. private DefaultCache defaultCache;
  13. @Test
  14. void testDefaultCache(){
  15. System.out.println(defaultCache.toString());
  16. //FAQ? defaultCache变量引用的对象是由谁创建的,存储 到了哪里?bean pool
  17. }
  18. }

第三步:运行单元测试类进行应用分析

启动运行单元测试方法,检测其输出结果,基于结果分析:

1)SpringBoot项目中Bean对象的构建。

2)SpringBoot项目中Bean对象的获取。

运行过程中的BUG分析

Bean类型找不到,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

空指针异常(NullPointerExcetpion-NPE),如图所示:

Idea工具中创建 SpringBoot工程及入门详解

启动类找不到,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

启动类有多个,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

NoSuchBeanDefinition异常,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

单元测试类中的方法添加了参数,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

SpringBoot 项目中的对象特性分析

 

准备工作

第一步:创建项目Module,例如名字为05-springboot-features,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

第二步:添加业务类ObjectPool,代码如下:

  1. package com.cy.pj.common.pool;
  2. @Component
  3. public class ObjectPool{//假设此对象为一个对象池
  4. public ObjectPool(){//假设运行项目启动类,此构造方法执行了,说明此类对象构建了。
  5. Systemd.out.println("ObjectPool()")
  6. }
  7. }

思考:一般池对象有什么特点?

1)在JVM内存会开辟一块相对比较大的空间。

2)在这块空间中存储一些对象(思考基于什么存储结构进行存储-数组,链表,散列表)。

3)基于“享元模式”设计思想,实现内存中对象的可重用性。

第三步:定义单元测试,代码如下:

  1. package com.cy.pj.pool;
  2. import com.cy.pj.common.pool.ObjectPool;
  3. import org.junit.jupiter.api.Test;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.boot.test.context.SpringBootTest;
  6.  
  7. @SpringBootTest
  8. public class ObjectPoolTests {
  9.  
  10. @Autowired
  11. private ObjectPool objectPool01;
  12. @Autowired
  13. private ObjectPool objectPool02;
  14. @Test
  15. void testObjectPool01(){
  16. System.out.println(objectPool01==objectPool02);
  17. }
  18. }

延迟加载

现在思考一个问题,对于ObjectPool这个类,假如项目启动以后,暂时不会用到这个池对象,是否有必要对其进行创建(默认是会创建的)?我们知道没必要,因为占用内存。那如何在启动时不创建此类对象呢?借助Spring框架提供的延迟加载特性进行实现。例如,我们可以在需要延迟加载的类上使用@Lazy注解进行描述,代码如下:

  1. package com.cy.pj.common.pool;
  2. @Lazy
  3. @Component
  4. public class ObjectPool{//假设此对象为一个对象池
  5. public ObjectPool(){//假设运行项目启动类,此构造方法执行了,说明此类对象构建了。
  6. Systemd.out.println("ObjectPool()")
  7. }
  8. }

此时,我们再去运行运行启动类,检测ObjectPool对象是否创建了,假如没有创建,说明延迟加载生效了。此时,我们总结一下,什么对象适合使用延迟加载特性呢?大对象,稀少用(项目启动以后,暂时用不到)的对象。

注意:延迟加载并不是延迟对类进行加载,而是在启动时,暂时不创建类的实例。假如想看一下内存中的类是否被加载了,可以通过JVM参数进行检测,参数为-XX:+TraceClassLoading。

对象作用域分析

在实际的项目中内存中的对象有一些可能要反复应用很多次,有一些可能用完以后再也不用了或者说应用次数很少了。对于经常要重复使用的对象我可考虑存储到池中(例如交给spring框架进行管理),应用次数很少的对象那就没必要放到池中了,用完以后让它自己销毁就可以了。在Spring项目工程中为了对这样的对象进行设计和管理,提供了作用域特性的支持,具体应用:

  1. package com.cy.pj.common.pool;
  2. @Scope("singleton")
  3. @Lazy
  4. @Component
  5. public class ObjectPool{//假设此对象为一个对象池
  6. public ObjectPool(){//假设运行项目启动类,此构造方法执行了,说明此类对象构建了。
  7. Systemd.out.println("ObjectPool()")
  8. }
  9. }

其中,在上面的代码中,我们使用了@Scope注解对类进行描述,用于指定类的实例作用域。不写@Scope默认就是单例(singleton)作用域,这个作用域会配合延迟加载(@Lazy)特性使用,表示此类的实例在需要时可以创建一份并且将其存储到spring的容器中(Bean池),需要的时候从池中取,以实现对象的可重用。假如一些对象应用次数非常少,可以考虑不放入池中,进而使用@Scope("prototype")作用域对类进行描述,让此类的对象何时需要何时创建,用完以后,当此对象不可达了,则可以直接被GC系统销毁。

对象生命周期方法

程序中的每个对象都有生命周期,对象创建,初始化,应用,销毁的这个过程称之为对象的生命周期。在对象创建以后要初始化,应用完成以后要销毁时执行的一些方法,我们可以称之为生命周期方法。但不见得每个对象都会定义生命周期方法。在实际项目中往往一些池对象通常会定义这样的一些生命周期方法(例如连接池)。那这样的方法在spring工程中如何进行标识呢?通常要借助@PostConstruct和@PreDestroy注解对特定方法进行描述,例如:

  1. package com.cy.pj.common.pool;
  2. @Scope("singleton")
  3. @Lazy
  4. @Component
  5. public class ObjectPool{//假设此对象为一个对象池
  6. public ObjectPool(){
  7. Systemd.out.println("ObjectPool()")
  8. }
  9. @PostConstruct
  10. public void init(){
  11. System.out.println("init()");
  12. }
  13. @PreDestroy
  14. public void destory(){
  15. System.out.println("destory()");
  16. }
  17. }

其中:

1)@PostConstruct 注解描述的方法为生命周期初始化方法,在对象构建以后执行.

2)@PreDestroy 注解描述的方法为生命周期销毁方法,此方法所在的对象,假如存储到了spring容器,那这个对象在从spring容器移除之前会先执行这个生命周期销毁方法(prototype作用域对象不执行此方法).

SpringBoot 项目中的依赖注入过程分析

 

在SpringBoot工程中,假如类与类之间存在着一定的依赖关系,Spring是如何进行依赖注入的呢,现在我们就通过一个案例做一个分析。

准备工作

第一步:创建一个项目module,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

第二步:启动运行项目,检测是否能成功启动

案例设计及分析

为了更好理解spring框架的底层注入机制,现在进行案例API设计,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

在这个案例中单元测试类CacheTests中定义一个Cache接口类型的属性,然后由Spring框架完成对cache类型属性值的注入。

代码编写及测试分析

第一步:定义Cache接口,代码如下:

  1. package com.cy.pj.common.cache;
  2. public interface Cache {
  3.  
  4. }

第二步:定义Cache接口实现类SoftCache,代码如下:

  1. package com.cy.pj.common.cache;
  2.  
  3. @Component
  4. public class SoftCache implements Cache{
  5.  
  6. }

第三步:定义Cache接口实现类WeakCache,代码如下:

  1. package com.cy.pj.common.cache;
  2.  
  3. @Component
  4. public class WeakCache implements Cache{
  5.  
  6. }

第四步:定义CacheTests单元测试类,代码如下:

  1. package com.cy.pj.common.cache;
  2. import org.junit.jupiter.api.Test;
  3.  
  4. @SpringBootTest
  5. public class CacheTests {
  6. @Autowired
  7. @Qualifier("softCache")
  8. private Cache cache;
  9.  
  10. @Test
  11. public void testCache() {
  12. System.out.println(cache);
  13. }
  14. }

其中,@Autowired由spring框架定义,用于描述类中属性或相关方法(例如构造方法)。Spring框架在项目运行时假如发现由他管理的Bean对象中有使用@Autowired注解描述的属性或方法,可以按照指定规则为属性赋值(DI)。其基本规则是:首先要检测容器中是否有与属性或方法参数类型相匹配的对象,假如有并且只有一个则直接注入。其次,假如检测到有多个,还会按照@Autowired描述的属性或方法参数名查找是否有名字匹配的对象,有则直接注入,没有则抛出异常。最后,假如我们有明确要求,必须要注入类型为指定类型,名字为指定名字的对象还可以使用@Qualifier注解对其属性或参数进行描述(此注解必须配合@Autowired注解使用)。

第五步:运行CacheTests检测输出结果,基于结果理解其注入规则。

编写及测试过程中的BUG分析

 

依赖注入异常,如图所示:

Idea工具中创建 SpringBoot工程及入门详解

总结(Summary)

 

本小节为springboot技术入门章节,主要讲述了SpringBoot工程下,spring中bean对象的编写,特性以及依赖注入的规则,希望通过这一小节的讲解,同学们能够理解我们为什么要将对象交给spring管理,spring管理对象有什么优势,我们在springboot工程中应该如何配置这些对象。

到此这篇关于Idea工具中创建 SpringBoot工程及入门分析详解的文章就介绍到这了,更多相关idea创建 SpringBoot工程内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家!