spring-boot搭建完整项目步骤记录

最新推荐文章于 2024-08-12 16:24:31 发布
最新推荐文章于 2024-08-12 16:24:31 发布
阅读量335 收藏 3
点赞数
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/anwebDesigner/article/details/103487829
版权

数据库： MySQL    

相关插件：mybatis-spring-boot-starter，swagger2，代码自动生成器（见附件）

开发工具：IDEA

前提条件，相关JDK，maven，java环境都配置好了。

第一步使用idea搭建项目

选择相关依赖项。

一个基础的项目就建好了。

新建一个dome测试文件验证一下。

package com.example.shop;

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

@RestController
public class dome {

    @RequestMapping("/hello")
    public String hello() {
        return "Hello Spring Boot!";
    }
}

启动项目，打开浏览器，访问http://localhost:8080/hello

启动成功。
 

第二步，建立数据库。

使用数据库连接软件在mysql 数据库中建立自己的数据库。

CREATE TABLE `goods` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(50) COLLATE utf8_bin NOT NULL COMMENT '商品名称',
  `type_id` int(11) DEFAULT NULL COMMENT '商品类型',
  `price` decimal(7,2) DEFAULT NULL COMMENT '商品价格',
  `imgages` varchar(60) COLLATE utf8_bin DEFAULT NULL COMMENT '商品图片',
  `sell_count` int(11) DEFAULT NULL COMMENT '商品销售数量',
  `creat_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间（自动生成）',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='商品表';


CREATE TABLE `goods_detail` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `goods_id` int(11) NOT NULL COMMENT '商品ID',
  `detail` text COLLATE utf8_bin COMMENT '商品详情',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='商品详情表';


CREATE TABLE `goods_type` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `type_name` char(20) COLLATE utf8_bin NOT NULL COMMENT '分类名称',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='商品分类表';

第三步，使用代码生成工具自动生成相关代码。

下载代码生成器，修改generator.xml的相关配置，连接自己的数据库。

使用cmd命令打开生成器窗口，输入命令：

java -jar mybatis-generator-core-1.3.2.jar -configfile generator.xml -overwrite

将生成的文件，复制到项目中。

也可以不用代码生成器，自己建这些文件。这些文件都是很基础的，就不放源码了。使用代码生成器唯一的好处就是方便快捷。

第四步，安装插件，修改配置。

1、打开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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.2.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>shop</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>shop</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<scope>runtime</scope>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

        <!--集成mybatis-->
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>2.1.0</version>
		</dependency>

        <!--动态生成接口文档-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

	</dependencies>

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

        <finalName>shop</finalName>

        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
                <excludes>
                    <exclude>static/**/fonts/**</exclude>
                    <exclude>static/**/css/**</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>false</filtering>
                <includes>
                    <include>static/**/fonts/**</include>
                    <include>static/**/css/**</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>

	</build>

</project>

一定要注意自己项目框架版本  

spring-boot-starter-parent的版本和相关插件的版本是不是适配的，不适配的话项目跑不起来。

可以去这个网站查看版本信息和版本依赖

https://mvnrepository.com/

 

2、application.properties 文件改成 application.yml ，并填写相关配置。

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.11.10:11306/test?useUnicode=yes&characterEncoding=UTF8
    username: root
    password: 123456


#jar方式下的tomcat配置
server:
  port: 8011

#mybatis配置
mybatis:
  mapper-locations: classpath*:com/example/shop/persistence/**/xml/*.xml
  type-aliases-package: com.example.shop.persistence.entity

改名是为了配置简单。

3、修改启动类，ShopApplication。

package com.example.shop;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.example.shop.persistence.mapper")
public class ShopApplication {

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

}

编写JSON工具。JSONResult。直接复制别人项目里面的拿来用就行。

package com.example.shop.utils;

/**
 * @Description
 * @Author by sm
 * @Create 2017/05/09 11:42
 */

public class JSONResult {
    public final static Integer SUCCESS=1;
    public final static Integer ERROR=0;

    private Integer code;
    private String msg;
    private Object result;

    public JSONResult() {
    }

    public JSONResult(Integer code, String msg, Object result) {
        this.code = code;
        this.msg = msg;
        this.result = result;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public Object getResult() {
        return result;
    }

    public void setResult(Object result) {
        this.result = result;
    }

    /**
     * 渲染失败数据
     *
     * @return result
     */
    public static JSONResult renderError() {
        JSONResult result = new JSONResult();
        result.setCode(ERROR);
        result.setMsg("error");
        return result;
    }

    /**
     * 渲染失败数据（带消息）
     *
     * @param msg 需要返回的消息
     * @return result
     */
    public static JSONResult renderError(String msg) {
        JSONResult result = renderError();
        result.setMsg(msg);
        return result;
    }

    /**
     * 渲染失败数据（带消息，带数据）
     *
     * @param msg 需要返回的消息
     * @param obj 需要返回的对象
     * @return result
     */
    public static JSONResult renderError(String msg, Object obj) {
        JSONResult result = renderError();
        result.setMsg(msg);
        result.setResult(obj);
        return result;
    }

    public static JSONResult renderError(Integer code, String msg, Object obj) {
        JSONResult result = renderError();
        result.setCode(code);
        result.setMsg(msg);
        result.setResult(obj);
        return result;
    }

    /**
     * 渲染成功数据
     *
     * @return result
     */
    public static JSONResult renderSuccess() {
        JSONResult result = new JSONResult();
        result.setMsg("success");
        result.setCode(SUCCESS);
        return result;
    }

    /**
     * 渲染成功数据（带消息，带数据）
     *
     * @param obj 需要返回的对象
     * @return result
     */
    public static JSONResult renderSuccess(Object obj) {
        JSONResult result = renderSuccess();
        result.setResult(obj);
        return result;
    }
}

编写服务类和控制器。项目结构如下：

IGoodsService文件

package com.example.shop.modules.sys.service;

import com.example.shop.persistence.entity.Goods;
import com.example.shop.persistence.entity.GoodsDetail;
import com.example.shop.utils.JSONResult;

public interface IGoodsService {

    // 查询
    Goods getGoods(Integer id);


    //新增  关联表新增
    void insertGoodsAll(Goods goods, GoodsDetail goodsDetail);

}

GoodsServiceImp文件
package com.example.shop.modules.sys.service.impl;

import com.example.shop.persistence.entity.Goods;
import com.example.shop.persistence.entity.GoodsDetail;
import com.example.shop.persistence.mapper.GoodsDetailMapper;
import com.example.shop.persistence.mapper.GoodsMapper;
import com.example.shop.modules.sys.service.IGoodsService;
import com.example.shop.utils.JSONResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import static com.example.shop.utils.JSONResult.renderSuccess;


@Service
public class GoodsServiceImp implements IGoodsService {

    @Autowired
    private GoodsMapper goodsMapper;

    @Autowired
    private GoodsDetailMapper goodsDetailMapper;

    /*
    根据ID查询商品信息
    */
    @Override
    public Goods getGoods(Integer id){
        return goodsMapper.selectByPrimaryKey(id);
    }

    /*
    新增数据
    关联表新增
     */
    @Override
    public void insertGoodsAll(Goods goods, GoodsDetail goodsDetail){
        // 插入goods 表数据
        goodsMapper.insertSelective(goods);
        // 获取 新增的goods数据ID，赋值给 goodsDetail表的goodsId字段
        goodsDetail.setGoodsId(goods.getId());
        // 将数据插入 goodsDetail 表
        goodsDetailMapper.insertSelective(goodsDetail);
    }

}

备注下：这里用了关联表插入，需要修改persistence文件夹里面GoodsMapper.xml里面的相关代码

......


<insert id="insertSelective" parameterType="com.example.shop.persistence.entity.Goods" useGeneratedKeys="true" keyProperty="id">

.....

控制器文件 GoodsController

package com.example.shop.modules.sys.controller;


import com.example.shop.persistence.entity.Goods;
import com.example.shop.persistence.entity.GoodsDetail;
import com.example.shop.modules.sys.service.IGoodsService;
import com.example.shop.utils.JSONResult;
import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import javax.swing.*;

@Api(tags = "商品接口")
@RestController
@RequestMapping("/sys/goods")
public class GoodsController {

    @Autowired
    private IGoodsService goodsService;

    @ApiOperation(value = "查询",notes = "通过ID查商品详情")
    @ApiImplicitParam(name = "id", value = "商品ID", required = true, dataType = "Int", paramType = "path")
    @GetMapping("/{id}")
    public JSONResult getGoods(@PathVariable("id") Integer id){
        Goods goods = goodsService.getGoods(id);
        return JSONResult.renderSuccess(goods);
    }

    /**
     * 新增商品
     * @param goods
     * @return
     */
    @ApiOperation(value = "新增",notes = "")
    @PostMapping("/insert")
    public JSONResult insertGoodsAll(Goods goods, GoodsDetail goodsDetail){
        goodsService.insertGoodsAll(goods, goodsDetail);
        return JSONResult.renderSuccess();
    }
}

接口文档配置文件SwaggerConfig

package com.example.shop.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author wujiaxing
 * <p>
 *     接口文档 配置文件
 * 使用Swagger2只需三步
 * 1、导入Swaggerr依赖
 * 2、配置Docket的bean
 * 3、使用@Api等注解修饰
 * </p>
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 创建API应用
     * appinfo()增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例，用来控制那些接口暴露给Swagger来展现
     * 本例采用置顶扫描的包路径来定义指定要建立API的目录
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.shop.modules.sys.controller"))
                .paths(PathSelectors.any()).build();
        return docket;
    }


    /**
     * 创建改API的基本信息（这些基本信息会展示在文档页面中）
     * 访问地址： http://项目实际地址/swagger-ui.html
     * @return
     */
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("java插件动态生成接口文档")
                .termsOfServiceUrl("http://localhost")
                .contact("an")
                .version("2.9.2")
                .build();
    }
}

然后再启动项目，浏览器输入：http://localhost:8011/swagger-ui.html

测试接口

成功！

剩下的自己再慢慢写增删改查。

马上风
关注
专栏目录
SpringBoot 搭建web项目过程记录
挣扎·前行
03-28 549
起一个新项目，SpringMVC + mybatis + mysql，常规选项，用SpringBoot（2.1.3）来搭。 官网用Spring Initializr创建代码框架后，写Controller，不起作用（用了jsp做模板文件）。
Springboot 项目搭建-详细版
edwardwzw的博客
05-05 1286
在 test 目录下新建 CodeGenerator 类，用于 mybatis-plus 自动生成 java 代码。注意：Springboot02Application 与 system 模块必须是同级的！
SpringBoot项目中各层介绍总结
最新发布
lijianhua的博客
08-12 1432
业务逻辑层，完成功能的设计 和dao层一样都是先设计接口，再创建要实现的类，然后在配置文件中进行配置其实现的关联。model是模型的意思，与entity、domain、pojo类似，是存放实体的类，类中定义了多个类属性，并与数据库表的字段保持一致，一张表对应一个model类。控制层，控制业务逻辑service，控制请求和响应，负责前后端交互 controller层主要调用Service层里面的接口控制具体的业务流程，控制的配置也要在配置文件中进行。
Springboot 新建项目流程记录
shenxian1021的专栏
04-06 157
1、配置java环境，安装jdk和maven就不说了，下载安装idea，打开idea，新建一个springboot项目 2、按照提示，一路next下去。 这里我们只选择spring web，其他有需要的话，再通过配置pom.xml来安装依赖。 3、把这些不要的删除掉 4、初始目录如图所示： 5、新建个controller包，新建一个IndexController控制...
搭建Spring Boot 项目
CQRNB的博客
02-16 7321
详细介绍搭建完整的Spring Boot项目 使用mybatis-plus链接数据库 通过swagger生成接口文档 测试接口
spring boot 搭建web项目完整流程
HA_LLL的博客
10-11 734
https://blog.csdn.net/fyhailin/article/details/79413864 该链接讲的十分完整，能解决大部分问题。 其中笔者启动不成功的原因就是其中一个坑：application.properties中使用了 spring.mvc.view.prefix=/ spring.mvc.view.suffix=.jsp 而我使用的不是新版，应该写成 spring.v...
spring-boot spring-security-oauth2 完整demo
11-22
首先，Spring Boot是基于Spring框架的快速开发工具，它简化了Spring应用的初始搭建以及配置过程，使得开发者可以专注于业务逻辑，而无需过多关注基础设施的配置。通过在项目中引入Spring Boot，我们可以快速创建一个...
Spring-Boot - 初步搭建
06-20
基本的 Spring-Boot Web-MVC 项目搭建步骤 #### 2.1 环境准备 确保你已经安装了以下工具： - Java 1.8 或更高版本 - Maven 3.3 或更高版本 - IntelliJ IDEA 15 或更高版本 - Thymeleaf 3 （可选，用于模板引擎） ...
spring-boot-starter-mybatis-spring-boot-2.2.0.zip
04-19
首先，`spring-boot-starter-mybatis`是Spring Boot官方提供的一个starter模块，它的主要作用是简化MyBatis在Spring Boot项目中的配置和使用。它包含了MyBatis的核心库、SqlSessionFactoryBuilder、...
spring-boot-starter-mybatis-spring-boot-1.3.3.tar.gz
04-19
《Spring Boot集成MyBatis详解》 在现代Java开发领域，Spring Boot以其便捷的初始化、自动配置和微服务...通过这些步骤，你可以轻松地在Spring Boot项目中构建起MyBatis的数据访问层，实现高效、灵活的数据库操作。
spring-boot-starter-mybatis-spring-boot-1.2.1.tar.gz
04-19
通过使用"spring-boot-starter-mybatis-spring-boot-1.2.1"这个压缩包，开发者可以快速搭建起具备数据访问功能的Spring Boot应用，同时享受到MyBatis带来的灵活SQL操作。理解并熟练运用这些知识，对于提升开发效率和...
springboot超详细教程_Spring Boot项目搭建步骤（超详细）
weixin_39801356的博客
12-19 966
在 Spring Tools 4 for Eclipse 中依次选择 File->New->Maven Project，然后在出现的界面中按图 1 所示增加相关信息。图 1创建 maven 项目完了上述操作之后，在 pom.xml 中添加 Spring Boot 的依赖，代码如下所示。org.springframework.bootspring-boot-starter-paren...
springboot项目搭建步骤
Mr super
09-07 188
springboot项目搭建步骤 打开idea 选择新建项目 下一步 下一步 需要的勾上 注意有时候限制版本号 在右上角又一个下拉框 可以选择 然后就下一步到运行就可以了
SpringBoot工程创建过程
喝水都塞牙
10-25 273
一、创建一个Maven工程， 2. 4. next 在pom.xml文件中添加启动依赖 <!--springboot要求，项目要继承spring-boot-starter-parent起步依赖--> <parent> <groupId>org.springframework.boot</groupId> <art...
springboot项目 记录日志
qq_095的博客
08-18 285
application.yml 中进行配置 logging: file: target/app.log level: ROOT: WARN com.springbootrestfulapi: TRACE #包名 com.springbootrestfulapi: TRACE #包名 import org.apache.commons.logging.Log; ...
springboot框架搭建详细过程
搁浅浅浅浅浅
06-11 1702
1.创建 1.1 新建springboot项目，如图。 1.2 选择Spring Initializr。 1.3 填写Group（企业名）、Artifact（项目名）和Name，这里选择默认，后点击next，如下图所示。 1.4选择需要的组件：基本组件有web模块中的web和web server、SQL模块中的MySQL、JDBC和Mybatis，项目版本号可以选择默认。 1.5.最后确定一下项目名以及选择一下项目的存储路径，点击finish。 1.6 创建完成后整个项目架构如下图所示。其中De
SpringBoot搭建步骤
weixin_55833709的博客
06-08 361
手动使用Maven项目，搭建一个完整的SpringBoot项目
springboot项目搭建运行步骤
qq_29380733的博客
01-17 633
首先，前端页面想要跑起来，要安装nodejs，然后node –v看一下版本，检验是否安装成功，npm –v 也试一下。 安装完nodejs： Npm install live-server –g   必须有这一步！！！ 我自己电脑的运行效果，之前因为没有联网会安装不了，所以必须联网。 2.后端想要跑起来，要安装阿里云的依赖： 第一个和第三个里头都有bat文件，直接运行即可安...
搭建springboot项目过程
lcecube的博客
11-25 291
搭建springboot项目过程 1. 建立Maven项目，导入spring boot父工程 修改pom.xml： <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
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值