首页手记创建Spring Boot项目入门教程

创建Spring Boot项目入门教程

标签：

SpringBoot

概述

本文详细介绍了如何创建Spring Boot项目入门，从环境准备到项目创建，再到编写第一个Spring Boot应用和常用功能实现。通过本文，读者可以轻松掌握创建Spring Boot项目的基本步骤和常用配置，从而快速上手Spring Boot开发。文中涵盖了Java开发环境安装、IDE配置、构建工具使用以及Spring Boot项目创建和运行的全过程。创建Spring Boot项目入门的相关知识在此得到了全面覆盖。

环境准备

在开始创建Spring Boot项目之前，首先需要确保你的开发环境已经准备好。以下是准备环境的步骤：

安装Java开发环境

Spring Boot是基于Java开发的，因此需要安装Java开发环境。你可以从Oracle官网或OpenJDK下载Java开发工具包（JDK）。安装完成后，需要设置环境变量。以下是环境变量设置示例：

# 设置JAVA_HOME环境变量
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64

# 设置PATH环境变量
export PATH=$JAVA_HOME/bin:$PATH

验证Java是否安装成功：

java -version

输出应显示Java版本信息，如：

java version "11.0.12" 2021-07-20 LTS
Java(TM) SE Runtime Environment (build 11.0.12+7-LTS)
Java HotSpot(TM) 64-Bit Server VM (build 11.0.12+7-LTS, mixed mode, sharing)

安装IDE（如IntelliJ IDEA或Spring Tool Suite）

推荐使用IntelliJ IDEA或Spring Tool Suite（STS）作为开发环境。以下是安装步骤：

安装IntelliJ IDEA

访问JetBrains官网，下载适合你操作系统的版本。
安装并启动IntelliJ IDEA。
在首次启动时，选择“Import Project”导入现有项目，或者选择“New Project”来创建新项目。

安装Spring Tool Suite（STS）

访问Spring官网下载STS。
安装并启动STS。
在首次启动时，按照向导完成初始化。初始化完成后，在STS中进行以下配置：
- 打开“File” -> “Settings” -> “Build, Execution, Deployment” -> “Gradle” 或 “Maven” 部分，根据需要配置Gradle或Maven。
- 安装并启用Spring Boot插件。在“File” -> “Settings” -> “Plugins”中搜索“Spring Boot”，然后点击“Install”。

安装Maven或Gradle构建工具

Spring Boot项目通常使用Maven或Gradle进行构建。以下是安装步骤：

安装Maven

访问Maven官网，下载适合你操作系统的版本。
解压下载的文件到你选择的目录。
设置Maven环境变量：

export MAVEN_HOME=/path/to/maven
export PATH=$MAVEN_HOME/bin:$PATH

验证Maven是否安装成功：

mvn -v

输出应显示Maven版本信息，如：

Apache Maven 3.8.1 (05b52b5b2d4c3b323b108f92aebc666ba1dda2b8; 2021-02-25T03:51:59Z)
Maven home: /path/to/maven
Java version: 11.0.12, vendor: Private Build, runtime: /usr/lib/jvm/java-11-openjdk-amd64
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "5.4.0-104-generic", arch: "amd64", family: "unix"

安装Gradle

访问Gradle官网，下载适合你操作系统的版本。
解压下载的文件到你选择的目录。
设置Gradle环境变量：

export GRADLE_HOME=/path/to/gradle
export PATH=$GRADLE_HOME/bin:$PATH

验证Gradle是否安装成功：

gradle -v

输出应显示Gradle版本信息，如：

Gradle 6.8.3
-----------------------------------------------------------
Build time:   2021-03-17 14:25:43 UTC
Revision:     77592b78710a0054916215e99b99359162c1a813
Groovy:       2.5.14
Ant:          Apache Ant(TM) version 1.10.9 compiled on April 24 2021
JVM:          11.0.12 (Private Build 11.0.12+7-LTS)
OS:           Linux 5.4.0-104-generic amd64

创建Spring Boot项目

在准备好开发环境后，接下来是创建Spring Boot项目。可以通过Spring Initializr在线创建项目，也可以通过IDE直接创建项目。

使用Spring Initializr在线创建项目

访问Spring Initializr。
选择项目的基本信息，如语言（Java）、依赖（如Web、JPA等）。
点击“Generate Project”下载压缩包。
解压下载的压缩包，导入到IDE中。

使用IDE直接创建项目

使用IntelliJ IDEA创建项目

启动IntelliJ IDEA。
选择“File” -> “New” -> “Project”。
选择“Spring Initializr”。
填写项目基本信息，如项目名称、Java版本、模块名称等。
选择所需的依赖，如Web、JPA等。
点击“Finish”完成项目创建。

使用Spring Tool Suite（STS）创建项目

启动STS。
选择“File” -> “New” -> “Spring Starter Project”。
填写项目基本信息，如项目名称、Java版本、模块名称等。
选择所需的依赖，如Web、JPA等。
点击“Finish”完成项目创建。

导入Spring Boot Starter依赖

在项目创建完成后，需要确保导入了Spring Boot Starter依赖。Spring Boot Starter是一组预配置的依赖集合，简化了Spring Boot项目的配置。

在pom.xml（Maven项目）或build.gradle（Gradle项目）文件中添加依赖配置。以下是一些常见依赖的示例：

Maven项目

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

Gradle项目

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

编写第一个Spring Boot应用

创建Spring Boot项目后，接下来是编写第一个Spring Boot应用。这包括创建主类、添加注解和配置，然后运行应用并访问默认端口。

创建主类

主类是Spring Boot应用的入口点，负责启动和初始化应用。创建一个名为Application.java的Java类，并添加以下代码：

package com.example.demo;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.SpringApplication;

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

解释代码

@SpringBootApplication：这是一个组合注解，简化了Spring Boot应用的配置。它包含了@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解。
- @Configuration：表示当前类是配置类，可以使用@Bean注解定义配置信息。
- @EnableAutoConfiguration：启用自动配置功能，简化配置。
- @ComponentScan：启用组件扫描，自动发现和管理应用程序组件。
SpringApplication.run：启动Spring Boot应用。

添加注解和配置

在主类中添加注解和配置，可以进一步定制应用的行为。例如，可以通过@EnableWebMvc启用Web MVC功能，或者通过@ComponentScan指定组件扫描的包路径。

配置应用端口

默认情况下，Spring Boot应用运行在8080端口。可以通过application.properties或application.yml配置文件来更改端口号。

使用`application.properties`文件

在src/main/resources目录下创建application.properties文件，添加以下配置：

server.port=8081

使用`application.yml`文件

在src/main/resources目录下创建application.yml文件，添加以下配置：

server:
  port: 8081

自定义Spring Boot配置类

可以创建自定义配置类来添加更多的配置信息。例如，创建一个名为AppConfig.java的配置类：

package com.example.demo.config;

import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@EnableWebMvc
@ServletComponentScan
public class AppConfig implements WebMvcConfigurer {
    // 自定义配置信息
}

在主类中使用自定义配置类

在主类中添加自定义配置类的注解：

package com.example.demo;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.SpringApplication;
import org.springframework.context.annotation.Import;

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

运行应用并访问默认端口

在IDE中右键点击主类，选择“Run”运行应用。
打开浏览器，访问http://localhost:8081，可以看到默认的欢迎页面。

常用功能实现

在Spring Boot项目中，有许多常用的功能可以实现，如配置文件使用、创建Controller和简单的REST API、使用Spring Boot Starter Data JPA进行数据库操作等。

配置文件使用（application.properties/application.yml）

Spring Boot支持多种配置文件格式，如application.properties和application.yml。配置文件可以用于设置各种应用属性，如端口号、数据源配置等。

使用`application.properties`文件

在src/main/resources目录下创建application.properties文件，添加以下配置：

server.port=8081
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root

使用`application.yml`文件

在src/main/resources目录下创建application.yml文件，添加以下配置：

server:
  port: 8081

spring:
  datasource:
  url: jdbc:mysql://localhost:3306/mydb
  username: root
  password: root

通过代码访问配置属性

可以在主类或配置类中通过@Value注解或@ConfigurationProperties注解来访问配置属性。

使用`@Value`注解

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Value;

@SpringBootApplication
public class Application {
    @Value("${spring.datasource.url}")
    private String dbUrl;

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

    @Bean
    public void printDbUrl() {
        System.out.println("Database URL: " + dbUrl);
    }
}

使用`@ConfigurationProperties`注解

package com.example.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties {
    private String url;
    private String username;
    private String password;

    // Getter和Setter方法
}

在主类中注入DataSourceProperties：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

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

    @Bean
    public DataSourceProperties dataSourceProperties() {
        return new DataSourceProperties();
    }
}

创建Controller和简单的REST API

在Spring Boot项目中，可以创建Controller来处理HTTP请求。以下是一个简单的REST API示例。

创建`HelloController.java`类

在src/main/java目录下创建HelloController.java类，添加以下代码：

package com.example.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Spring Boot!";
    }
}

测试REST API

启动应用。
打开浏览器，访问http://localhost:8081/hello，可以看到返回的欢迎信息。

使用Spring Boot Starter Data JPA进行数据库操作

Spring Boot Starter Data JPA提供了一套简单的ORM（对象关系映射）功能，用于操作数据库中的数据。以下是一个简单的示例。

创建实体类`User.java`

在src/main/java目录下创建User.java类，添加以下代码：

package com.example.demo.entity;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;

    // Getter和Setter方法
}

创建Repository接口`UserRepository.java`

在src/main/java目录下创建UserRepository.java接口，添加以下代码：

package com.example.demo.repository;

import com.example.demo.entity.User;
import org.springframework.data.repository.CrudRepository;

public interface UserRepository extends CrudRepository<User, Long> {
}

创建Service类`UserService.java`

在src/main/java目录下创建UserService.java类，添加以下代码：

package com.example.demo.service;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    public User saveUser(User user) {
        return userRepository.save(user);
    }

    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }
}

创建Controller类`UserController.java`

在src/main/java目录下创建UserController.java类，添加以下代码：

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }

    @PostMapping
    public User saveUser(@RequestBody User user) {
        return userService.saveUser(user);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        userService.deleteUser(id);
    }
}

测试数据库操作

启动应用。
使用Postman或浏览器发送HTTP请求来测试数据库操作。

构建和部署

在完成应用开发后，可以将项目打包为可执行的jar文件，并部署到本地或云端服务器。

打包项目为可执行的jar文件

使用Maven打包

在IDE中右键点击项目，选择“Maven” -> “Install”。
或者在命令行中执行：

mvn clean install

生成的jar文件位于target目录下。

使用Gradle打包

在IDE中右键点击项目，选择“Gradle” -> “Tasks” -> “build”。
或者在命令行中执行：

gradle build

生成的jar文件位于build/libs目录下。

运行打包后的jar文件

java -jar target/myapp.jar

部署到本地或云端服务器

部署到本地服务器

将打包后的jar文件复制到远程服务器。
使用SSH登录到远程服务器。
执行以下命令来运行jar文件：

java -jar myapp.jar

部署到云端服务器

可以使用各种云服务提供商提供的服务来部署Spring Boot应用，如Google Cloud、AWS、Azure等。以下是使用Google Cloud的示例步骤：

注册并登录Google Cloud账户。
创建一个新的Google Cloud项目。
创建一个App Engine应用。
将打包后的jar文件上传到Google Cloud Storage。
使用Google Cloud SDK将应用部署到App Engine：

gcloud app deploy

常见问题与解决方案

在开发过程中，经常会遇到各种问题。以下是一些常见问题及其解决方案。

解决编码问题

问题描述

在处理中文字符时，可能会遇到编码问题，如乱码。

解决方案

在application.properties或application.yml配置文件中设置编码格式：

spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
spring.http.encoding.force=true

spring:
  http:
  encoding:
  charset: UTF-8
  enabled: true
  force: true

解决依赖冲突

问题描述

在引入多个依赖时，可能会出现依赖冲突，导致应用无法正常运行。

解决方案

使用mvn dependency:tree或gradle dependencies命令查看依赖树，找出冲突的依赖。可以使用<exclusions>标签排除冲突的依赖，或者使用<dependencyManagement>标签来管理依赖版本。

使用Maven排除冲突依赖

<dependency>
    <groupId>com.example</groupId>
    <artifactId>example-dependency</artifactId>
    <version>1.0.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.example</groupId>
            <artifactId>conflict-dependency</artifactId>
        </exclusion>
    </exclusions>
</dependency>

使用Gradle排除冲突依赖

dependencies {
    implementation('com.example:example-dependency:1.0.0') {
        exclude group: 'com.example', module: 'conflict-dependency'
    }
}

使用日志框架记录信息

在Spring Boot项目中，可以使用日志框架来记录应用的日志信息。默认情况下，Spring Boot使用Logback作为日志框架，可以通过application.properties或application.yml配置文件来更改日志配置。

使用`application.properties`文件

logging.level.root=INFO
logging.file.name=app.log
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n

使用`application.yml`文件

logging:
  level:
  root: INFO
  file:
  name: app.log
  pattern:
  console: '%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n'

自定义日志配置

可以创建自定义的日志配置文件logback.xml，并将配置文件路径添加到application.properties或application.yml中。

创建`logback.xml`文件

在src/main/resources目录下创建logback.xml文件，添加以下配置：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.example.demo" level="DEBUG" />

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

在`application.properties`中引用日志配置文件

spring.logging.logback.configuration-file=classpath:logback.xml

在`application.yml`中引用日志配置文件

spring:
  logging:
  logback:
  configuration-file: classpath:logback.xml

在代码中记录日志信息

可以在代码中使用@Slf4j注解来记录日志信息：

package com.example.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    private static final Logger logger = LoggerFactory.getLogger(Application.class);

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
        logger.info("Application is running");
    }
}

通过以上步骤，可以有效地解决编码问题、依赖冲突和日志记录等问题，确保Spring Boot应用的稳定性和可维护性。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

噜噜哒

移动开发工程师

手记
篇

粉丝

8

获赞与收藏

25

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30787 345

网络编程入门教程

20个小节 12720 239

Pandas 入门教程

25个小节 18599 341

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

创建Spring Boot项目入门教程

安装IntelliJ IDEA

安装Spring Tool Suite（STS）

安装Maven

安装Gradle

使用IntelliJ IDEA创建项目

使用Spring Tool Suite（STS）创建项目

Maven项目

Gradle项目

解释代码

配置应用端口

使用application.properties文件

使用application.yml文件

自定义Spring Boot配置类

在主类中使用自定义配置类

使用application.properties文件

使用application.yml文件

通过代码访问配置属性

使用@Value注解

使用@ConfigurationProperties注解

创建HelloController.java类

测试REST API

创建实体类User.java

创建Repository接口UserRepository.java

创建Service类UserService.java

创建Controller类UserController.java

测试数据库操作

使用Maven打包

使用Gradle打包

运行打包后的jar文件

部署到本地服务器

部署到云端服务器

问题描述

解决方案

问题描述

解决方案

使用Maven排除冲突依赖

使用Gradle排除冲突依赖

使用application.properties文件

使用application.yml文件

自定义日志配置

创建logback.xml文件

在application.properties中引用日志配置文件

在application.yml中引用日志配置文件

在代码中记录日志信息

阅读免费教程

使用`application.properties`文件

使用`application.yml`文件

使用`application.properties`文件

使用`application.yml`文件

使用`@Value`注解

使用`@ConfigurationProperties`注解

创建`HelloController.java`类

创建实体类`User.java`

创建Repository接口`UserRepository.java`

创建Service类`UserService.java`

创建Controller类`UserController.java`

使用`application.properties`文件

使用`application.yml`文件

创建`logback.xml`文件

在`application.properties`中引用日志配置文件

在`application.yml`中引用日志配置文件