Java Spring Boot 项目开发示例指南

开发和扩展一个 Java Spring Boot 项目可以分为几个步骤。以下是一个简单的指南，涵盖项目的创建、基本功能的实现、以及扩展的示例。

第一步：创建 Spring Boot 项目

使用 Spring Initializr 创建项目:
- 访问 Spring Initializr
- 选择项目的配置（如 Maven 或 Gradle，Java 版本，Spring Boot 版本等）
- 添加依赖项，如 Spring Web、Spring Data JPA、H2 Database（或其他数据库）
- 点击 "Generate" 下载项目压缩包并解压。
导入项目到 IDE:
- 使用 IntelliJ IDEA 或 Eclipse 等 IDE 导入解压后的项目。

第二步：编写基本代码

创建基本的 Controller :

在 src/main/java/com/example/demo 目录下创建 HelloController.java。

java 复制代码

package com.example.demo;

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 :

在同一目录下创建 HelloService.java。

java 复制代码

package com.example.demo;

import org.springframework.stereotype.Service;

@Service
public class HelloService {
    public String getGreeting() {
        return "Hello, Service!";
    }
}

将 Service 注入 Controller :

修改 HelloController 以使用 HelloService。

java 复制代码

@RestController
public class HelloController {
    private final HelloService helloService;

    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    @GetMapping("/hello")
    public String hello() {
        return helloService.getGreeting();
    }
}

第三步：配置数据库

在 application.properties 中配置数据库:

properties 复制代码

spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=

创建实体类 :

创建 User 实体。

java 复制代码

package com.example.demo;

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;

    // getters and setters
}

创建 Repository :

创建 UserRepository 接口。

java 复制代码

package com.example.demo;

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

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

使用 Repository :

创建 UserService。

java 复制代码

@Service
public class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

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

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

第四步：扩展功能

添加用户相关的 Controller :

创建 UserController。

java 复制代码

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

    public UserController(UserService userService) {
        this.userService = userService;
    }

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

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

添加测试 :

在 src/test/java/com/example/demo 中添加测试类。

java 复制代码

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testCreateUser() throws Exception {
        String userJson = "{\"name\":\"John Doe\"}";
        mockMvc.perform(post("/users")
                .contentType(MediaType.APPLICATION_JSON)
                .content(userJson))
                .andExpect(status().isOk());
    }
}

第五步：运行和测试

运行应用 :

在 IDE 中运行主类（DemoApplication.java）。
使用 Postman 或浏览器测试 API:
- 访问 http://localhost:8080/hello
- 访问 http://localhost:8080/users 进行用户相关操作。

结论

通过以上步骤，你已经成功创建并扩展了一个基本的 Spring Boot 项目。你可以根据需求进一步添加功能，例如安全性、前端界面、API 文档等。