Springboot-从零搭建一个项目前言实战

前言

提前了解

搭建一个 Springboot 项目的方法有多种:

  1. 通过 Spring 官网的工具 start.spring.io/
  2. 通过 Idea 的脚手架
  3. 通过 Eclipse 的插件
  4. 通过 Maven 引入依赖

常见的大致这些,就不一一介绍了,个人比较喜欢通过 Maven 来创建,这也是本篇的内容。

本篇主要内容

开发工具:Jetbrain Idea、Git

开发语言:Java

开发平台:Windows

期望目标:手动搭建一个 Springboot 项目,并成功运行。

实战

开发详细步骤

1、创建项目目录

新建一个空文件夹,命名为 xiaoming-system ,这也是我们项目的名称。

2、添加初始文件

添加三个初始文件,分别为:

文件名 文件含义
pom.xml Maven 工程的配置文件,Idea 会自动识别它,并创建一个 Maven 工程
.gitignore Git 代码仓库,进行代码版本管理的忽略文件
readme.md 本项目的描述文件

文件内容,分别为:

① 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>cc.xiaoming</groupId>
    <artifactId>xiaoming-system</artifactId>
    <packaging>pom</packaging>
    <version>1.0.0</version>

    <!-- 本项目的父级依赖,指定了 Springboot 的各种规范 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
        <relativePath/>
    </parent>

    <!-- 各种属性参数 -->
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <!-- 各种依赖框架 -->
    <dependencies>
        <!-- springboot web 项目的起步依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

</project>
复制代码

② .gitignore

### IntelliJ IDEA ###
.idea
*.iml
target/
复制代码

③ readme.md

### 项目名称:小明个人网站
复制代码

④ 此时的项目目录

image.png

3、初始化版本库

① 在当前项目根目录下,初始化一个空的版本仓库:git init

② 将这三个初始文件添加到版本仓库的暂存区:git add .

③ 将这三个初始文件提交到版本仓库的版本库:git commit -m "初始化项目文件"

今后开发过程中,自己得记得提交代码,并填写好提交信息(描述你改动了哪些内容)。

4、初始化本项目

① 使用 Idea 打开项目目录 xiaoming-system,它会自动构建一个 Maven 工程出来。

image.png

② 你会发现多了一个 .idea 的文件夹和 .iml 后缀的文件,暂时不用关心它们,这是 Idea 自动生成的一些文件,提交代码到版本库时也请忽略它们。

③ 这里有个地方要注意一下,File -> Project Structure,查看一下项目使用的 JDK 版本,我这里用的 8。很多时候打开某个项目的时候,Idea 会自动帮你选择一个版本,不一定是你想用的版本,要手动改下,不然运行可能报错。

image.png

5、搭建 Springboot 项目

事实上,现在还是一个 Maven 工程,不过搭建 Springboot 项目也挺简单的,就是在 Maven 工程的基础上,引入 Springboot 依赖,然后进行业务逻辑的开发,就成了一个 Springboot 项目。

① 新建模块 module:xiaoming-starter,作为程序启动类所在模块。

image.png

image.png

② 此时项目下会多出一个模块。

image.png

③ xiaoming-starter 下 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>
    <parent>
        <artifactId>xiaoming-system</artifactId>
        <groupId>cc.xiaoming</groupId>
        <version>1.0.0</version>
    </parent>

    <artifactId>xiaoming-starter</artifactId>

</project>
复制代码

④ xiaoming-system 下 pom.xml 的内容,明显看到增加了一个 module,表明这是它的子模块:

<modules>
    <module>xiaoming-starter</module>
</modules>
复制代码

⑤ 添加程序启动类 XmApplication.java,它将作为整个程序的入口。

image.png

package cc.xiaoming;

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;

/**
 * springboot 程序启动类
 */
@SpringBootApplication
@RestController
public class XiaomingApplication {

    public static void main(String[] args) {
        SpringApplication.run(XiaomingApplication.class, args);
    }

    @RequestMapping("/hello")
    public String hello() {
        return "Hello, Welcome to xiaoming-system.";
    }
}
复制代码

6、运行程序

① 运行之前确认下依赖是否都导入了:

image.png

② 浏览器地址栏输入访问接口:

image.png

显然,运行成功,接口访问通了。

到此 Springboot 项目基本搭建完成,可以继续添加我们所需要的功能。

哦!对了,代码记得添加到版本库。