0
点赞
收藏
分享

微信扫一扫

2.通用工程


1.引入依赖

<?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>com.steven.movies</groupId>
<artifactId>movies_parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<groupId>com.steven.movies</groupId>
<artifactId>movies_common</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>movies_common</name>
<description>公共模块</description>
<properties>
<java.version>8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- Mybatis-plus引入的配置start -->
<!-- mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>

<!-- druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
</dependency>

<!-- 数据源驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>

<!-- 日志框架 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</dependency>
<!-- Mybatis-plus时引入的配置 end -->

<!-- guava-->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>

<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>

<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</dependency>

<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.5.3</version>
</dependency>

<!-- JWT依赖 -->
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
</dependency>
</dependencies>

<build>
<!-- 资源引入 -->
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
</build>
</project>

2.config
在项目目录“/src/main/java/com/steven/movies/common”下新建config目录,并在config目录下新建DruidProperties、MybatisPlusConfig和JWTProperties类,具体代码如下。

@Data
@Configuration
@ConfigurationProperties(prefix = "spring.datasource")
public class DruidProperties {
private String url = "jdbc:mysql://127.0.0.1:3306/study?autoReconnect=true&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=CONVERT_TO_NULL&useSSL=false&serverTimezone=UTC";

private String username = "root";

private String password = "admin123";

private String driverClassName = "com.mysql.cj.jdbc.Driver";

private Integer initialSize = 2;

private Integer minIdle = 1;

private Integer maxActive = 20;

private Integer maxWait = 60000;

private Integer timeBetweenEvictionRunsMillis = 60000;

private Integer minEvictableIdleTimeMillis = 300000;

private String validationQuery = "SELECT 'x'";

private Boolean testWhileIdle = true;

private Boolean testOnBorrow = false;

private Boolean testOnReturn = false;

private Boolean poolPreparedStatements = true;

private Integer maxPoolPreparedStatementPerConnectionSize = 20;

private String filters = "stat";

public void config(DruidDataSource dataSource) {

dataSource.setUrl(url);
dataSource.setUsername(username);
dataSource.setPassword(password);

dataSource.setDriverClassName(driverClassName);
//定义初始连接数
dataSource.setInitialSize(initialSize);
//最小空闲
dataSource.setMinIdle(minIdle);
//定义最大连接数
dataSource.setMaxActive(maxActive);
//最长等待时间
dataSource.setMaxWait(maxWait);

//配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
dataSource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

//配置一个连接在池中最小生存的时间,单位是毫秒
dataSource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
dataSource.setValidationQuery(validationQuery);
dataSource.setTestWhileIdle(testWhileIdle);
dataSource.setTestOnBorrow(testOnBorrow);
dataSource.setTestOnReturn(testOnReturn);

//打开PSCache,并且指定每个连接上PSCache的大小
dataSource.setPoolPreparedStatements(poolPreparedStatements);
dataSource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);

try {
dataSource.setFilters(filters);
} catch (SQLException e) {
e.printStackTrace();
}
}
}

@Configuration
@EnableTransactionManagement
@MapperScan(basePackages = {"com.steven.movies.**.dao.mapper"})
public class MybatisPlusConfig {
@Bean
public DruidDataSource dataSource(com.steven.movies.common.config.DruidProperties druidProperties) {
DruidDataSource dataSource = new DruidDataSource();
druidProperties.config(dataSource);
return dataSource;
}
}

@Data
public class JWTProperties {
private static JWTProperties jwtProperties = new JWTProperties();

private JWTProperties() {
}

public static JWTProperties getJwtProperties() {
return jwtProperties;
}

public static final String JWT_PREFIX = "jwt";

private String header = "Authorization";

private String secret = "defaultSecret";

//默认是七天
private Long expiration = 604800L;

private String authPath = "login";

private String md5Key = "randomKey";
}

3.exception
在项目目录“/src/main/java/com/steven/movies/common”下新建exception目录,并在exception目录下新建CommonServiceException和BaseExceptionHandler类,具体代码如下。

@Data
public class CommonServiceException extends Exception{
private Integer code;

private String message;

public CommonServiceException(int code,String message){
this.code = code;
this.message = message;
}
}

@Slf4j
@ControllerAdvice
public class BaseExceptionHandler {
@ExceptionHandler(CommonServiceException.class)
@ResponseBody
public ServerResponse serviceExceptionHandler(HttpServletRequest request, CommonServiceException e) {
log.error("CommonServiceException, uri:{}, code:{}, message:{}", request.getRequestURI(), e.getCode(), e.getMessage());

return ServerResponse.createByErrorCodeMessage(e.getCode(), e.getMessage());
}
}

4.request
在项目目录“/src/main/java/com/steven/movies/common”下新建request目录,并在request目录下新建BaseRequestVO和BasePageVO类,具体代码如下。

public abstract class BaseRequestVO {
public abstract void checkParam() throws CommonServiceException;
}

@Data
public class BasePageVO extends BaseRequestVO {
private Integer currentPage = 1;

private Integer pageSize = 10;

@Override
public void checkParam() throws CommonServiceException {

}
}

5.response
在项目目录“/src/main/java/com/steven/movies/common”下新建response目录,并在response目录下新建ResponseCode、ServerResponse和PageResult类,具体代码如下。

public enum ResponseCode {
//1.定义枚举值
ERROR(0,"ERROR"),

SUCCESS(1,"SUCCESS");

//2.定义枚举属性
private final int code;

private final String desc;

//3.定义构造函数
ResponseCode(int code, String desc){
this.code = code;
this.desc = desc;
}

//4.定义get方法
public int getCode(){
return code;
}

public String getDesc(){
return desc;
}
}

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
//保证序列化json的时候,如果是null的对象,key也会消失
public class ServerResponse<T> implements Serializable {
//1.定义属性
private int status;

private String message;

private T data;

//2.定义构造函数
private ServerResponse() {

}

private ServerResponse(int status) {
this.status = status;
}

private ServerResponse(int status, T data) {
this.status = status;
this.data = data;
}

private ServerResponse(int status, String message, T data) {
this.status = status;
this.message = message;
this.data = data;
}

private ServerResponse(int status, String message) {
this.status = status;
this.message = message;
}

//3.getter方法
public int getStatus() {
return status;
}

public T getData() {
return data;
}

public String getMessage() {
return message;
}

@JsonIgnore
//使之不在json序列化结果当中
//4.判断这个响应是不是一个正确的响应
public boolean isSuccess() {
return this.status == ResponseCode.SUCCESS.getCode();
}

//5.定义返回对象的方法
public static <T> ServerResponse<T> createBySuccess() {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
}

public static <T> ServerResponse<T> createBySuccessMessage(String message) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message);
}

public static <T> ServerResponse<T> createBySuccess(T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), data);
}

public static <T> ServerResponse<T> createBySuccess(String message, T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message, data);
}

public static <T> ServerResponse<T> createByError() {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), ResponseCode.ERROR.getDesc());
}

public static <T> ServerResponse<T> createByErrorMessage(String errorMessage) {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), errorMessage);
}

public static <T> ServerResponse<T> createByErrorCodeMessage(int errorCode, String errorMessage) {
return new ServerResponse<T>(errorCode, errorMessage);
}

public static <T> ServerResponse<T> createByErrorCodeMessageData(int errorCode, String errorMessage,T data) {
return new ServerResponse<T>(errorCode, errorMessage,data);
}
}

@Data
public class PageResult {
private Long totalSize;

private Long totalPages;

private Long pageSize;

private Long currentPage;

private Object data;
}

6.utils
在项目目录“/src/main/java/com/steven/movies/common”下新建utils目录,并在utils目录下新建JWTUtil、ToolUtil、MD5Util和PageUtil类,具体代码如下。

public class JWTUtil {
private JWTProperties jwtProperties = JWTProperties.getJwtProperties();

/**
* 从token中获取用户名
*/
public String getUsernameFromToken(String token) {
return getClaimFromToken(token).getSubject();
}

/**
* 从token中获取JWT发布时间
*/
public Date getIssuedAtDateFromToken(String token) {
return getClaimFromToken(token).getIssuedAt();
}

/**
* 从token中获取JWT失效时间
*/
public Date getExpirationDateFromToken(String token) {
return getClaimFromToken(token).getExpiration();
}

/**
* 从token中获取JWT接收者
*/
public String getAudienceFromToken(String token) {
return getClaimFromToken(token).getAudience();
}

/**
* 从token中获取claim
*/
public String getPrivateClaimFromToken(String token, String key) {
return getClaimFromToken(token).get(key).toString();
}

/**
* 从token中获取Md5 key
*/
public String getMd5KeyFromToken(String token) {
return getPrivateClaimFromToken(token, jwtProperties.getMd5Key());
}

/**
* 从token中获取JWT的payload部分
*/
public Claims getClaimFromToken(String token) {
return Jwts.parser()
.setSigningKey(jwtProperties.getSecret())
.parseClaimsJws(token)
.getBody();
}

/**
* 解析token是否正确,不正确会抛异常
*/
public void parseToken(String token) throws JwtException {
Jwts.parser().setSigningKey(jwtProperties.getSecret()).parseClaimsJws(token).getBody();
}

/**
* 验证token是否失效
* true:过期
* false:未过期
*/
public Boolean isTokenExpired(String token) {
try {
final Date expiration = getExpirationDateFromToken(token);
return expiration.before(new Date());
} catch (ExpiredJwtException expiredJwtException) {
return true;
}
}

/**
* 生成token
*/
public String generateToken(String userName, String randomKey) {
Map<String, Object> claims = new HashMap<>();
claims.put(jwtProperties.getMd5Key(), randomKey);
return doGenerateToken(claims, userName);
}

/**
* 生成token
*/
private String doGenerateToken(Map<String, Object> claims, String subject) {
final Date createdDate = new Date();
final Date expirationDate = new Date(createdDate.getTime() + jwtProperties.getExpiration() * 1000);

return Jwts.builder()
.setClaims(claims)
.setSubject(subject)
.setIssuedAt(createdDate)
.setExpiration(expirationDate)
.signWith(SignatureAlgorithm.HS512, jwtProperties.getSecret())
.compact();
}

/**
* 获取随机字符串
*/
public String getRandomKey() {
return getRandomString(6);
}


/**
* 获取指定长度的随机字符串
*/
private String getRandomString(int length) {
String base = "abcdefghijklmnopqrstuvwxyz0123456789";
Random random = new Random();
StringBuffer sb = new StringBuffer();
for (int i = 0; i < length; i++) {
int number = random.nextInt(base.length());
sb.append(base.charAt(number));
}
return sb.toString();
}
}

public class ToolUtil {
//数字正则表达式
private static final Pattern pattern = Pattern.compile("[0-9]*");

private ToolUtil() {
}

/**
* 判断字符串是否为空
*/
public static boolean strIsNull(String str) {
if (str == null || str.trim().length() == 0) {
return true;
} else {
return false;
}
}

/**
* 判断字符串是不是数值类型
*/
public static boolean checkInt(String str) {
Matcher isNum = pattern.matcher(str);
if (!isNum.matches()) {
return false;
} else {
return true;
}
}

/**
* 字符串转数值类型
*/
public static Integer str2Int(String str) {
Matcher isNum = pattern.matcher(str);
if (!isNum.matches()) {
return 0;
} else {
return Integer.parseInt(str);
}
}

/**
* 字符串转LocalDateTime
*/
public static LocalDateTime str2LocalDateTime(String dateStr) {
DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
LocalDateTime ldt = LocalDateTime.parse(dateStr, df);
return ldt;
}
}

public class MD5Util {
public static String encrypt(String source) {
return encodeMd5(source.getBytes());
}

private static String encodeMd5(byte[] source) {
try {
return encodeHex(MessageDigest.getInstance("MD5").digest(source));
} catch (NoSuchAlgorithmException e) {
throw new IllegalStateException(e.getMessage(), e);
}
}

private static String encodeHex(byte[] bytes) {
StringBuffer buffer = new StringBuffer(bytes.length * 2);
for (int i = 0; i < bytes.length; i++) {
if (((int) bytes[i] & 0xff) < 0x10) {
buffer.append("0");
}
buffer.append(Long.toString((int) bytes[i] & 0xff, 16));
}
return buffer.toString();
}
}

public class PageUtil {
public static PageResult getPageResult(IPage page) {
PageResult pageResult = new PageResult();
pageResult.setCurrentPage(page.getCurrent());
pageResult.setPageSize(page.getSize());
pageResult.setTotalPages(page.getPages());
pageResult.setTotalSize(page.getTotal());
pageResult.setData(page.getRecords());
return pageResult;
}
}

7.通用工程目录结构

2.通用工程_xml


举报

相关推荐

0 条评论