Spring Boot2 系列教程 (二) | 第一个 SpringBoot 工程详解
微信公众号:一个优秀的废人
如有问题或建议,请后台留言,我会尽力解决你的问题。
前言
哎呦喂,按照以往的惯例今天周六我的安排应该是待在家学学猫叫啥的。但是今年这种日子就可能一去不复返了,没法办法啊。前几天年轻,立下了一周至少更两篇文章的 flag 。废话少说,今天接着前文给你们带来了第一个 springboot 工程的详解。
第一个 springboot 工程
前文已经说过了 springboot 工程的创建,这里不再赘述,还不会的朋友,请看下面这篇文章。
学过编程的都知道,学习一门新语言的第一个项目肯定是 hello world 。那这里也不例外,我们先创建一个非常简单的 hello world 工程。给大家讲解 springboot 的项目目录。创建信息如下:
由于本文重点旨在讲解 springboot 的项目目录。所以选择的依赖包非常简单,就选择 web 足矣。
springboot 项目目录详解
创建成功之后的 springboot 项目目录如下,以下对各主要目录的作用进行讲解:
- src 是整个工程的根目录,基本上做 web 开发你的代码大部分都放在这里。其中 main 目录下放置的是你的 java 代码;resource 目录,顾名思义就是放置配置文件、静态资源( static )以及前端模板( template )。
- test 目录就是放置你的单元测试代码。
- target 就是项目编译生成的目录,里面包含代码编译后的 class 文件以及一些静态资源和配置文件。
- external libraries 这里放置了,pom.xml 导入的依赖包。
- 其他没提到的目录都是不重要的。
由上图项目目录,可以看到有几个文件,这些文件有些是我新建的,有些是项目生成的。下面我会讲解:
- pom.xml 这个文件是整个项目最重要的文件,它包含了整个项目的依赖包。maven 会根据这个文件导入相关的我们开发需要的依赖包。代码如下:
可以看到 pom.xml 中一共有 4 个依赖,其中只有 junit 是我手动加入的,用于单元测试。
其他的如 spring boot 启动父依赖、spring boot web依赖 、spring boot web test依赖都是创建项目时,勾选 web 选项卡而生成的。这几个依赖包的额作用就是 内嵌 tomcat 容器,集成各 spring 组件。比如 如果没有依赖 web 包 ,spring 的两大核心功能 ioc 和 aop 将不会生效。
<?xml version="1.0" encoding="utf-8"?> <project xmlns="http://maven.apache.org/pom/4.0.0" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xsi:schemalocation="http://maven.apache.org/pom/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelversion>4.0.0</modelversion> <groupid>com.nasus</groupid> <artifactid>helloworld</artifactid> <version>0.0.1-snapshot</version> <name>helloworld</name> <description>demo project for spring boot</description> <properties> <java.version>1.8</java.version> </properties> <!-- spring boot 启动父依赖 --> <parent> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-parent</artifactid> <version>2.1.1.release</version> <relativepath/> <!-- lookup parent from repository --> </parent> <dependencies> <!-- spring boot web依赖 --> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-test</artifactid> <scope>test</scope> </dependency> <!-- junit --> <dependency> <groupid>junit</groupid> <artifactid>junit</artifactid> <version>4.12</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> </plugin> </plugins> </build> </project>
- helloworldapplication.java 最为重要,它由项目生成,是整个工程的应用启动类 main 函数。代码由项目生成,代码如下:springapplication 引导应用,并将 helloworldapplication 本身作为参数传递给 run 方法。具体 run 方法会启动嵌入式的 tomcat 并初始化 spring环境及其各 spring 组件。
需要注意的是,这个类必须放在其他类的上册目录,拿上述目录举个栗子, 若其他helloworldcontroller.java 类位于 com.nasus.controller 下。则 helloworldapplication.java 类必须放置在 com.nasus 下或者 com 下(层级必须大于其他 java 类)。否则启动项目访问会报 whitelabel error page 错误,原因是项目扫描不到 @restcontroller、@requestmapping 等注解配置的方法和类。
package com.nasus.helloworld; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; @springbootapplication public class helloworldapplication { public static void main(string[] args) { springapplication.run(helloworldapplication.class, args); } }
- helloworldcontroller 是我手动编写的,代码如下:@restcontroller 和 @requestmapping 注解是来自 springmvc 的注解,它们不是 springboot 的特定部分。
其中 @restcontroller 注解的作用是:提供实现了 rest api,可以服务 json、xml 或者其他。这里是以 string 的形式渲染出结果。
其中 @restcontroller 注解的作用是:提供路由信息,"/“路径的http request都会被映射到sayhello方法进行处理。
具体参考,spring 官方的文档《spring framework document》
package com.nasus.controller; import org.springframework.web.bind.annotation.requestmapping; import org.springframework.web.bind.annotation.restcontroller; /** * project name:helloworld <br/> * package name:com.nasus.controller <br/> * date:2019/1/5 13:59 <br/> * <b>description:</b> todo: 描述该类的作用 <br/> * * @author <a href="turodog@foxmail.com">nasus</a><br/> * copyright notice ========================================================= * this file contains proprietary information of eastcom technologies co. ltd. * copying or reproduction without prior written approval is prohibited. * copyright (c) 2019 ======================================================= */ @restcontroller public class helloworldcontroller { @requestmapping("/hello") public string sayhello() { return "hello,world!"; } }
写完 controller 层的代码,我们就可以启动此项目。点击 idea 项目启动按钮,效果如下:
- 好的程序必须配备完善的单元测试。helloworldcontrollertest.java 文件是由我编写的主要作用就是测试 helloworldcontroller.java 中的方法。这里用的是 junit 依赖包进行单元测试,代码如下:这里的逻辑就是测试 helloworldcontroller.java 的 sayhello 方法输出的字符是否是 hello,world!
package com.nasus; import static org.junit.assert.assertequals; import com.nasus.controller.helloworldcontroller; import org.junit.test; /** * project name:helloworld <br/> * package name:com.nasus <br/> * date:2019/1/5 14:01 <br/> * <b>description:</b> todo: 描述该类的作用 <br/> * * @author <a href="turodog@foxmail.com">nasus</a><br/> * copyright notice ========================================================= * this file contains proprietary information of eastcom technologies co. ltd. * copying or reproduction without prior written approval is prohibited. * copyright (c) 2019 ======================================================= */ public class helloworldcontrollertest { @test public void testsayhello() { assertequals("hello,world!",new helloworldcontroller().sayhello()); } }
编写完成之后,可以通过以下按钮启动单元测试类。
测试结果如下:可以看到红圈框住的地方,出现这个绿色标志证明单元测试没问题。sayhello 方法的结果是对的。
后语
我为什么要写这种这么简单的教程?
是这样的,我始终认为比我聪明的人有很多,但比我笨的人也不少。在中国有很多你认为众所周知的事,其实有一车人根本不知道,这篇文章哪怕只帮助到一个人,足矣。
之后我打算出一个 springboot 系列的教程,敬请关注与指正,本人也是一个小菜鸟在打怪升级中,如本文有不正确的地方,烦请指正。一起学习一起进步。
以上就是使用 idea 创建 springboot 的过程,希望对你们有帮助。如果看到这里,说明你喜欢这篇文章,请转发、点赞。微信搜索「一个优秀的废人」,关注后回复「1024」送你一套完整的 java 教程。
推荐阅读
-
Android笔记之:App应用之发布各广告平台版本的详解
-
基于Android中Webview使用自定义的javascript进行回调的问题详解
-
为Android应用增加渠道信息 自动化不同渠道的打包过程的使用详解
-
基于Android设计模式之--SDK源码之策略模式的详解
-
Android开发笔记之:ListView刷新顺序的问题详解
-
基于Android开发支持表情的实现详解
-
Android开发笔记之:AsyncTask的应用详解
-
Android 上下滚动TextSwitcher实例详解
-
vertus fluid mask怎么用 vertus fluid mask3抠图插件图文使用教程
-
Idm破解教程 Idm本地破解欺骗注册方法[已测]