我是这样使用SpringBoot(创建项目)

目录

创建SpringBoot项目

这里是用IDEA做演示,安装配置好开发工具,前面有讲我是这样使用SpringBoot(eclipse&IDEA配置JDK Maven docker)。这一章蒋完成SpringBoot项目的创建,开放一个简单的API接口。通过postman访问API接口。

创建根目录

打开IDEA,到创建项目界面。这里创建一个父模板,后面各个项目以子模块的方式进行。


创建项目界面

点击Create New Project,选中Maven项目,不要选择Create From archetype,点击Next


选择Maven

输入组名(GroupId)、项目名(ArtifactId)、版本号(Version),后点击next
parent

选择目录后点击Finish


选择目录

弹出创建目录的对话框点击OK
对话框

进入IDEA项目界面。
完成

这是parent项目,不需要src。因此,把src目录删除。
删除之后

引入SpringBoot

在parent项目的pom.xml中包含子模块中都会用到的模块,如SpringBoot、lombok等。把pom.xml内容修改如下:

<?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.biboheart.demos</groupId>
    <artifactId>bhparent</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

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

        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
        </dependency>

        <!-- 我常用的一些工具写在这个包里,源码地址:https://gitee.com/biboheart/brick 已经在maven中央仓库发布 -->
        <dependency>
            <groupId>com.biboheart</groupId>
            <artifactId>bh-brick</artifactId>
            <version>0.0.6</version>
        </dependency>
    </dependencies>

</project>

当前SpringBoot稳定的最新版是2.1.3,我们就用2.1.3来演示吧。

版本

spring boot 官网中选中Learn可以查看。点击Reference Doc.可以查看spring boot此版本的官方文档。
这个版本要求Java8及以上版本,Maven 3.3以上
这时,界面状态
父项目

创建第一个项目

先来一个最基本的项目,只是提供一个API。

  1. 在bhparent项目名上右键->New->Module


    右键
  2. 选择Maven项目,勾选Create from archetype,使用“maven-archetype-puickstart”,点击“Next”


    创建maven模块
  3. 填写模块ArtifactId为bhhello,GroupId与Version就用默认的,如果有改变,在模块的pom.xml文件也可以修改。


    模块ArtifactId
  4. 确认信息,Maven的配置项在前面已经讲过。这里可以修改配置文件。


    确认信息
  5. 模块名称。前面(第2步)填写的是模块ID,是maven项目属性,是全局的,如果发布到中央仓库,可以用来拉取模块。这里填的是模块名称,也就是项目目录,是本地的。IDEA默认为模块ArtifactId,可以修改。这里就不改了。


    模块名称
  6. 点击Finish完成创建。在IDEA右下方查看创建进度。


    查看进度

项目结构

一个基本的maven项目的目录结构,是这样的。在项目根目录一个pom.xml文件和src文件夹,src文件夹中存放项目源码。在src目录下是main和test两个文件夹,main文件夹下存放主要的项目文件,test文件下存放测试的文件。main和test下的目录结构一样,包含一个java目录和resources目录。java目录中存放java源代码,resources目录中存放配置文件,资源文件等。一般情况下,test中测试main中的类,使用相同的包名。如图,com.biboheart.demos。


目录结构

IDEA默认生成的项目文件名为App和AppTest。这个项目不做测试,删除test/jave/下的包和文件。main中的App改名成HelloApplication。
IDEA的更名操作,右键App文件,Refactor->Rename


更名

更名

完成后项目结构
项目结构

修改bhhello项目的pom.xml文件,把暂时用不上的去掉。内容如下

<?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">

    <parent>
        <artifactId>bhparent</artifactId>
        <groupId>com.biboheart.demos</groupId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>bhhello</artifactId>

    <name>bhhello</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
    </dependencies>
</project>

项目开发

修改HelloApplication文件内容如下

package com.biboheart.demos;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class HelloApplication {
    public static void main( String[] args ) {
        SpringApplication.run(HelloApplication.class, args);
    }

    @RequestMapping(value = "/hello")
    public String hello(String name) {
        return "hello " + name;
    }
}

在IDEA中运行项目

HelloApplication上右键点击,选择Debug 'HelloApplication',调试运行项目


启动项目

项目开始启动,在控制台中会打印出运行信息。


运行信息

运行完成

在调试窗口中看到Undertow服务器已经启动,端口号为8080。项目已经完成启动。点击左边的红色方框可以停止。
停止按钮

测试

浏览器中GET测试。


浏览器GET

打开postman,或其它http调试工具。如何安装postman的问题请通过其它途径获取。
用GET方式请求。


GET

用POST方式请求
POST

代码分析

这个项目已经完成,到目前为止,这个项目创建,目录调整,maven依赖。进行了一个HelloApplication.java文件的编写。只是做了少量的开发,就完成了一个API服务。这就是spring boot的强大之处,快速构建项目。
下面分析下代码

package com.biboheart.demos;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class HelloApplication {
    public static void main( String[] args ) {
        SpringApplication.run(HelloApplication.class, args);
    }

    @RequestMapping(value = "/hello")
    public String hello(String name) {
        return "hello " + name;
    }
}
  1. @SpringBootApplication
    表示这是一个spring boot项目的入口。它包含了一些自动配置的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
  1. @RestController
    表示这是一个RESTful风格的API。配合class中的函数,实现API开放。
  2. main函数
    public static void main( String[] args ) {
        SpringApplication.run(HelloApplication.class, args);
    }

使用org.springframework.boot.SpringApplication类的run函数指定项目入口类,启动项目。

  1. @RequestMapping(value = "/hello")
    表示开放一个API,URI为“/hello”,API的实现是注解下面的函数。
  2. public String hello(String name) {}
    实现“/hello”,可以接收名为name的字符串参数。返回结果为String类型的字符串。当客户访问“http://localhost:8080/hello”时,会找到这个函数执行,并返回执行结果。这里是RESTful风格返回。
  3. spring boot默认服务端口是8080,可以配置,这个后面章节会讲到。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,692评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,482评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,995评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,223评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,245评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,208评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,091评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,929评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,346评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,570评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,739评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,437评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,037评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,677评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,833评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,760评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,647评论 2 354

推荐阅读更多精彩内容