IDE+springboot多模块项目的使用

UserGuan

已于 2022-07-14 20:29:13 修改

阅读量1.2k

点赞数

分类专栏： IDEA类文章标签： spring boot mybatis java

于 2019-09-06 13:14:41 首次发布

本文链接：https://blog.csdn.net/AdminGuan/article/details/100577295

版权

IDEA类专栏收录该内容

13 篇文章 0 订阅

订阅专栏

项目结构

创建多模块项目请看 IDE+springboot多模块项目搭建

一、multiblock-entity模块

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>

    <!-- 依赖项目的multiblock-parent父工程 -->
    <parent>
        <groupId>com.multiblock</groupId>
        <artifactId>multiblock-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <!-- 实体模块的基本信息 -->
    <groupId>com.multiblock</groupId>
    <artifactId>multiblock-entity</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>multiblock-entity</name>
    <packaging>jar</packaging>
    <description>实体模块</description>

    <dependencies>
        <!-- lombok主动生成get、set方法、构造函数等 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.9.0</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>javax.persistence</groupId>
            <artifactId>persistence-api</artifactId>
            <version>1.0</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

</project>

User实体类

package com.multiblock.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

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

@Data //自动为所有字段添加@ToString, @EqualsAndHashCode, @Getter方法，为非final字段添加@Setter和@RequiredArgsConstructor
@NoArgsConstructor //自动生成无参数构造函数
@AllArgsConstructor //自动生成全参数构造函数
public class User {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String username;
    private String password;
    private String phone;
    private String nickname;
    private String email;

}

二、multiblock-dao模块

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>

    <!-- 依赖项目的multiblock-parent父工程 -->
    <parent>
        <groupId>com.multiblock</groupId>
        <artifactId>multiblock-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <!-- 数据持久层模块的基本信息 -->
    <groupId>com.multiblock</groupId>
    <artifactId>multiblock-dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>multiblock-dao</name>
    <packaging>jar</packaging>
    <description>数据持久层模块</description>

    <properties>
        <mybatis.version>1.3.2</mybatis.version>
    </properties>

    <dependencies>
        <!-- mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
        <!-- 依赖multiblock-entity子模块 -->
        <dependency>
            <groupId>com.multiblock</groupId>
            <artifactId>multiblock-entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
        <!-- mybatis通用mapper依赖 -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-core</artifactId>
        </dependency>
    </dependencies>

</project>

UserDao数据持久化接口

package com.multiblock.dao;

import com.multiblock.entity.User;
import org.springframework.stereotype.Repository;
import tk.mybatis.mapper.common.Mapper;

@Repository
public interface UserDao extends Mapper<User> {

}

userMapper.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace用接口的全路径作为命名空间 -->
<mapper namespace="com.multiblock.dao.UserDao">

</mapper>

三、multiblock-service模块

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>

    <!-- 依赖项目的multiblock-parent父工程 -->
    <parent>
        <groupId>com.multiblock</groupId>
        <artifactId>multiblock-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <!-- 服务层模块的基本信息 -->
    <groupId>com.multiblock</groupId>
    <artifactId>multiblock-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>multiblock-service</name>
    <packaging>jar</packaging>
    <description>服务层模块</description>

    <dependencies>
        <!-- 依赖multiblock-entity子模块 -->
        <dependency>
            <groupId>com.multiblock</groupId>
            <artifactId>multiblock-entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
        <!-- 依赖multiblock-dao子模块 -->
        <dependency>
            <groupId>com.multiblock</groupId>
            <artifactId>multiblock-dao</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

</project>

UserService接口

package com.multiblock.service;

import com.multiblock.entity.User;

import java.util.List;

public interface UserService {

    // 添加用户信息
    Integer add(User user);

    // 删除用户信息
    Integer del(Integer id);

    // 修改用户信息
    Integer update(User user);

    // 根据id查询用户信息
    User load(Integer id);

    List<User> list();

}

UserServiceImpl实现类

package com.multiblock.service.impl;

import com.multiblock.dao.UserDao;
import com.multiblock.entity.User;
import com.multiblock.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service("userService")
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @Override
    public Integer add(User user) {
        return userDao.insert(user);
    }

    @Override
    public Integer del(Integer id) {
        return userDao.deleteByPrimaryKey(id);
    }

    @Override
    public Integer update(User user) {
        return userDao.updateByPrimaryKey(user);
    }

    @Override
    public User load(Integer id) {
        return userDao.selectByPrimaryKey(id);
    }

    @Override
    public List<User> list() {
        return userDao.selectAll();
    }

}

四、multiblock-controller模块

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>

    <!-- 依赖项目的multiblock-parent父工程 -->
    <parent>
        <groupId>com.multiblock</groupId>
        <artifactId>multiblock-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <!-- 控制层模块的基本信息 -->
    <groupId>com.multiblock</groupId>
    <artifactId>multiblock-controller</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>multiblock-controller</name>
    <packaging>jar</packaging>
    <description>控制层模块</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 依赖multiblock-entity子模块 -->
        <dependency>
            <groupId>com.multiblock</groupId>
            <artifactId>multiblock-entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
        <!-- 依赖multiblock-service子模块 -->
        <dependency>
            <groupId>com.multiblock</groupId>
            <artifactId>multiblock-service</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

</project>

UserController控制层

package com.multiblock.controller;

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

import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("user")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("doadd")
    public boolean doadd(User user, @RequestParam(defaultValue = "-1") Integer[] roleid) {
        boolean flag = false;
        if (user != null) {
            userService.add(user);
            flag = true;
        }
        return flag;
    }

    @RequestMapping("del/{id}")
    public boolean del(@PathVariable int id) {
        boolean flag = false;
        if (id > 0) {
            userService.del(id);
            flag = true;
        }
        return flag;
    }

    @PostMapping("doupdate")
    public boolean doupdate(User user, @RequestParam(defaultValue = "-1") Integer[] roleid) {
        boolean flag = false;
        if (user != null) {
            userService.update(user);
            flag = true;
        }
        return flag;
    }

    @GetMapping("load/{id}")
    public Map<String, Object> load(@PathVariable int id) {
        Map<String, Object> map = new HashMap<String, Object>();
        if (id > 0) {
            map.put("user", userService.load(id));
        } else {
            map = null;
        }
        return map;
    }

    @GetMapping("list")
    public Map<String, Object> list() {
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("users", userService.list());
        return map;
    }

}

application.yml配置文件

#设置端口号
server:
  port: 8090
#spring的配置
spring:
  #连接数据库
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3336/db_multiblock?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: root
    password: 123456
  #设置字符编码
  http:
    encoding:
      charset: utf-8
      enabled: true
      force: true
  #设置修改代码后自动重启服务
  devtools:
    livereload:
      enabled: true
#mybatis的配置
mybatis:
  type-aliases-package: com.multiblock.entity
  mapper-locations: classpath:mappers/*.xml

Start项目启动文件

package com.multiblock;

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

@SpringBootApplication
@MapperScan(basePackages = {"com.multiblock.dao"}) // 注意MapperScan要导tk的包，不然会报NoSuchMethodException
public class Start {

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

}

IDE+springboot多模块项目源码：multiblock源码

lombok常用注解介绍

1.@NonNull：使用 @NonNull 注解修饰的字段通过 set 方法设置时如果为 null, 将抛出 NullPointerException

2.@Cleanup：主要用来修饰 IO 流相关类, 会在 finally 代码块中对该资源进行 close();

3.@Getter,@Setter：为字段生成 getter,setter 方法, 标记到类上表明为所有字段生成

4.@ToString：生成 toString 方法, 默认打印所有非静态字段

5.@EqualsAndHashCode：生成 equals 和 hashCode 方法

6.@NoArgsConstructor：无参构造函数

7.@RequiredArgsConstructor：为未初始化的 final 字段和使用 @NonNull 标注的字段生成构造函数

8.@AllArgsConstructor：为所有字段生成构造函数

9.@Data：相当于同时使用@Getter,@Setter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor

10.@Value：使用后，类将使用final进行修饰，同时使用@ToString,@EqualsAndHashCode,@AllArgsConstructor,@Getter

11.@Builder：创建一个静态内部类, 使用该类可以使用链式调用创建对象
如 User 对象中存在 name,age 字段, User user=User.builder().name("姓名").age(20).build()

12.@SneakyThrows：对标注的方法进行try catch后抛出异常，可在value输入需要catch的异常数组，默认catch Throwable

13.@Synchronized：在标注的方法内使用synchronized($lock) {}对代码进行包裹，$lock为new Object[0]

14.@Log,@CommonsLog,@JBossLog,@Log,@Log4j,@Log4j2,@Slf4j,@XSlf4j：生成一个当前类的日志对象, 可以使用 topic 指定要获取的日志名称

15.自定义配置：虽然lombok能为我们快速生成代码，但是有一些生成的代码依然无法满足我们的需求。此时可配置lombok.config来解决问题，以下列出一些常用的配置：

lombok.getter.noIsPrefix=true(默认: false) #lombok默认对boolean类型字段生成的get方法使用is前缀，通过此配置则使用get前缀
lombok.accessors.chain=true(默认: false) #默认的set方法返回void设置为true返回调用对象本身
lombok.accessors.fluent=true(默认: false) #如果设置为true。get,set方法将不带get,set前缀，直接以字段名为方法名
lombok.log.fieldName=logger(默认: log) #设置log类注解返回的字段名称

注意：在IDEA中lombok.config配置文件要放置于src\main\java目录下，在src\main\resources中将不生效