Springboot资料：新手入门与初级教程

概述

本文全面介绍了Spring Boot的核心概念和开发流程，包括环境搭建、常用注解和配置，以及实战案例和常见问题解决方案。通过阅读，开发者可以快速掌握Spring Boot的使用方法和最佳实践，从而提高开发效率。文中提供了丰富的Spring Boot资料，帮助读者深入理解和应用Spring Boot框架。

Spring Boot简介 什么是Spring Boot

Spring Boot是由Pivotal团队提供的一个项目，其主要目的是简化Spring应用的初始搭建以及开发过程。它通过简单的配置和约定优于配置的原则，使得开发者能够快速创建独立、生产级别的基于Spring的应用程序。

Spring Boot的核心优势

• 简化的开发流程：Spring Boot通过约定优于配置的方式，自动配置了许多常见的功能，减少了大量的配置工作。
• 独立运行：Spring Boot应用可以打包为独立的可执行JAR文件，包含运行所需的全部依赖和配置。
• 内置的嵌入式服务器：如Tomcat、Jetty或Undertow，可以直接在应用中运行，无需额外的外部服务器。
• 自动配置：根据类路径中包含的jar文件自动配置Spring和其他库。
• 监控与健康检查：提供了健康检查端点和监控工具，如Micrometer和Actuator。
• 无需XML配置：采用Java注解配置方式，简化了传统的XML配置。

Spring Boot与传统Spring的区别

• 配置方式：传统Spring需要大量的XML或Java配置，而Spring Boot通过约定优于配置和自动配置，减少了配置文件的数量。
• 快速启动：Spring Boot应用可以快速启动，因为它预先配置了许多常见的需求，如开发和生产环境下的配置。
• 依赖管理：Spring Boot使用Maven或Gradle的依赖管理，减少了手动查找和管理库的麻烦。
• 集成测试：Spring Boot自带了对集成测试的支持，使得测试更加方便。
• 嵌入式服务器：Spring Boot提供了对嵌入式Web服务器的支持，如Tomcat、Jetty等，使得部署更加简单。

Spring Boot环境搭建 开发工具准备

IDE选择

• IDEA：IntelliJ IDEA，一款功能强大的Java集成开发环境，支持Spring Boot的插件。
• STS：Spring Tool Suite，基于Eclipse的集成开发环境，专门为Spring开发者设计，提供了Spring Boot项目模板。
• Maven：一个强大的项目管理工具，用于构建、依赖管理和项目信息管理。
• Gradle：一个开源的基于Groovy语言的构建工具，支持广泛的依赖管理。

创建Spring Boot项目

创建一个Spring Boot项目通常有以下几种方式：

1. 通过Spring Initializr创建：
   • 访问spring.io网站。
   • 选择项目的基本信息（如模块、语言、依赖等）。
   • 下载创建的项目压缩包，并解压到本地。
2. 通过IDE的内置工具创建：
   • 使用IntelliJ IDEA或STS等IDE，通过内置的Spring Initializr插件创建一个新的Spring Boot项目。
   • 在项目创建向导中选择所需的依赖和配置。

Maven和Gradle构建工具的使用

使用Maven

<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.example</groupId>
  <artifactId>demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.0</version>
  </parent>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 添加其他依赖 -->
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

使用Gradle

plugins {
  id 'org.springframework.boot' version '2.5.0'
  id 'io.spring.dependency-management' version '1.0.11.RELEASE'
  id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
  mavenCentral()
}

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  // 添加其他依赖
}

Spring Boot常用注解 @SpringBootApplication

@SpringBootApplication是Spring Boot项目中最常用的注解，它是一个复合注解，组合了@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解的功能。

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

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

通过@SpringBootApplication注解，你可以快速启动一个Spring Boot应用。

@RestController

@RestController是一个组合注解，它包含了@Controller和@ResponseBody两个注解的功能，主要用于定义REST风格的API。

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

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

@Service

@Service注解用于标识一个服务层的组件，通常用于定义业务逻辑。

import org.springframework.stereotype.Service;

@Service
public class UserService {
  // 业务逻辑实现
}

@Component

@Component是一个通用的注解，表示任何Spring组件，它可以被容器识别并管理。

import org.springframework.stereotype.Component;

@Component
public class MyComponent {
  // 通用组件的实现
}

@Repository

@Repository注解用于标识数据层的组件，如DAO对象。

import org.springframework.stereotype.Repository;

@Repository
public class UserRepository {
  // 数据层操作实现
}

@Configuration

@Configuration注解用于标识一个配置类，它定义了Spring的配置信息。

import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {
  // 配置信息
}

Spring Boot常用配置 application.properties与application.yml配置

application.properties

# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/dbname
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 端口配置
server.port=8080

# 日志配置
logging.level.root=INFO

application.yml

spring:
  datasource:
  url: jdbc:mysql://localhost:3306/dbname
  username: root
  password: password
  driver-class-name: com.mysql.cj.jdbc.Driver

server:
  port: 8080

logging:
  level:
    root: INFO

数据源配置（连接数据库）

Maven依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
</dependency>

配置数据源

spring.datasource.url=jdbc:mysql://localhost:3306/dbname
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.hibernate.ddl-auto=update

日志配置

Logback配置

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

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

日志级别

logging.level.root=INFO

端口配置

server.port=8080

Spring Boot实战案例 创建简单的REST API

定义REST控制器

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

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

测试REST API

启动应用并访问http://localhost:8080/hello，可以看到返回的消息Hello, Spring Boot!。

数据库连接与操作

创建实体类

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

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

  // Getter and Setter
}

创建Repository接口

import org.springframework.data.jpa.repository.JpaRepository;

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

使用Repository操作数据

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
  @Autowired
  private UserRepository userRepository;

  @GetMapping("/users")
  public List<User> getUsers() {
    return userRepository.findAll();
  }
}

使用Thymeleaf实现页面渲染

添加Thymeleaf依赖

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

创建HTML模板

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <title>Thymeleaf Example</title>
</head>
<body>
  <div th:each="user : ${users}">
    <p th:text="'Name: ' + ${user.name}"></p>
    <p th:text="'Email: ' + ${user.email}"></p>
  </div>
</body>
</html>

创建控制器

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

import java.util.List;

@Controller
public class ThymeleafController {
  @GetMapping("/users")
  public String listUsers(Model model) {
    List<User> users = userRepository.findAll(); // 假设userRepository已经定义
    model.addAttribute("users", users);
    return "users";
  }
}

使用Spring Security实现简单权限控制

添加Spring Security依赖

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

配置Spring Security

import org.springframework.context.annotation.Bean;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
  @Override
  protected void configure(HttpSecurity http) throws Exception {
    http
      .authorizeRequests()
        .antMatchers("/", "/home").permitAll()
        .anyRequest().authenticated()
      .and()
        .formLogin()
        .loginPage("/login")
        .permitAll()
      .and()
        .logout()
        .permitAll();
  }

  @Override
  @Bean
  public UserDetailsService userDetailsService() {
    InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
    manager.createUser(User.withDefaultPasswordEncoder()
      .username("user")
      .password("password")
      .roles("USER")
      .build());
    return manager;
  }
}

创建登录页面

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <title>Login</title>
</head>
<body>
  <form th:action="@{/login}" method="post">
    <input type="text" name="username" placeholder="Username" />
    <input type="password" name="password" placeholder="Password" />
    <input type="submit" value="Login" />
  </form>
</body>
</html>

创建控制器

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class LoginController {
  @GetMapping("/login")
  public String login() {
    return "login";
  }
}

项目启动失败常见原因及解决方法 依赖冲突

• 原因：多个库之间存在版本冲突。
• 解决方案：检查依赖树，找到冲突的依赖，并使用<dependencyManagement>或<dependency>中的<exclusions>排除冲突的版本。

<dependency>
  <groupId>com.example</groupId>
  <artifactId>moduleA</artifactId>
  <version>1.0</version>
  <exclusions>
    <exclusion>
      <groupId>org.example</groupId>
      <artifactId>conflict</artifactId>
    </exclusion>
  </exclusions>
</dependency>

使用Maven的依赖树查看

mvn dependency:tree

使用Gradle的依赖树查看

./gradlew dependencies

使用<dependencyManagement>解决版本冲突

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.example</groupId>
      <artifactId>moduleB</artifactId>
      <version>2.0</version>
    </dependency>
  </dependencies>
</dependencyManagement>

使用<exclusion>排除冲突依赖

<dependency>
  <groupId>com.example</groupId>
  <artifactId>moduleA</artifactId>
  <version>1.0</version>
  <exclusions>
    <exclusion>
      <groupId>org.example</groupId>
      <artifactId>conflict</artifactId>
    </exclusion>
  </exclusions>
</dependency>

配置错误

• 原因：配置文件中的某些配置项错误或缺失。
• 解决方案：仔细检查application.properties或application.yml文件，确保所有配置项正确无误。

依赖未下载

• 原因：依赖未下载或下载不完整。
• 解决方案：清理Maven或Gradle缓存，重新构建项目。

mvn clean install

./gradlew clean build

日志记录与调试技巧

日志级别设置

• 设置日志级别为DEBUG

logging.level.root=DEBUG

使用IDE调试

• 设置断点：在代码中设置断点，启动应用后，断点处会暂停执行。
• 查看变量值：在断点处查看变量的当前值。
• 单步执行：逐行执行代码，观察程序的运行过程。

使用@Profile注解

• 区分开发和生产环境

import org.springframework.context.annotation.Profile;

@Profile("dev")
@Configuration
public class AppConfig {
  // 开发环境配置
}

@Profile("prod")
@Configuration
public class AppConfig {
  // 生产环境配置
}

总结

通过本教程，你已经掌握了Spring Boot的基本概念、环境搭建、常用注解、常用配置、实战案例以及常见问题和解决方案。Spring Boot极大地简化了Java应用的开发和部署过程，使得开发者能够更专注于业务逻辑的实现。希望本教程对你有所帮助，更多详细内容请参考官方文档和在线教程。如果你想要学习更多Spring Boot的内容或者Spring相关的知识，推荐访问muoc.com进行深入学习。