# framework

**Repository Path**: fubluesky/framework

## Basic Information

- **Project Name**: framework
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-07
- **Last Updated**: 2021-09-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# framework

#### 介绍
通用框架

#### 项目源码

|        | 源码地址                                       |
| ------ | ---------------------------------------------- |
| github | https://github.com/guoshiqiufeng/framework.git |
| gitee  | https://gitee.com/fubluesky/framework.git      |

#### 软件架构
|              | 技术           | 版本  |
| ------------ | -------------- | ----- |
| 核心框架     | Spring Boot    | 2.4.2 |
| 阿里云OSS    | aliyun-sdk-oss | 2.8.3 |
| FTP 文件上传 | commons-net    | 3.8.0 |

#### 模块

| 名称         | 模块     |
| ------------ | -------- |
| 核心自动装配 | core-boot-starter |
| 阿里云oss | oss-ali-boot-starter |
| jwt | jwt-boot-starter |
| 核心依赖   | framework-core |
| 时间序列化配置         | framework-date  |



#### 安装教程
使用maven进行依赖安装
#### 使用说明

##### core-boot-starter

[使用说明](framework-boot/core-boot-starter/README.md)

##### **oss-ali-boot-starter**

[使用说明](framework-boot/oss-ali-boot-starter/README.md)



##### FTP文件上传

pom添加依赖

```xml
<dependency>
    <groupId>io.github.guoshiqiufeng</groupId>
    <artifactId>ftp-boot-starter</artifactId>
    <version>1.2.4</version>
</dependency>
```

application.yml添加配置

```yml
ftp:
  enabled: true #是否开启
  http-prefix: http://192.168.1.60:88 #文件访问地址前缀
  ftp-ip: 192.168.1.60 #ftp ip
  ftp-port: 21 #ftp port
  user-name: ftpuser #ftp 用户名
  password: ftpuser #ftp 密码
  is-passive: true #是否开启私有模式
  temp-dir: /home/ftp_tmp #临时文件目录
  prefix: develop #前缀 文件夹
```

需要使用上传的地方

```java
@Autowired
	private FtpSource ftpSource;

	@PostMapping("")
	public ResponseResult upload(@RequestParam(value = "file", required = false) MultipartFile file) throws Exception {
		if (file == null || file.isEmpty()) {
			throw new BusinessException("上传文件不能为空");
		}
		// 上传文件
		String suffix = file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf("."));
		String url = ftpSource.uploadSuffix(file.getBytes(), "/1", suffix);
		Map<String, String> result = Maps.newHashMap();
		result.put("url", url);
		result.put("prefix", ossSource.getHttpPrefix());
		return ResponseResult.success(result);
	}
```

输出到前端的json

```json
{
    "code": 200,
    "message": "成功",
    "data": {
        "prefix": "http://192.168.1.60:88",
        "url": "/prefix/1/20210118/1d9767ccd97743e9a1109eaba15888ce.jpg"
    }
}
```



##### jwt

pom添加依赖

```xml
<dependency>
    <groupId>io.github.guoshiqiufeng</groupId>
    <artifactId>jwt-boot-starter</artifactId>
    <version>1.2.4</version>
</dependency>
```

application.yml添加配置

```yml
jwt:
  # 加密秘钥
  secret: secret
  # token有效时长，7天，单位秒
  expire: 604800
  # refresh token 有效时长，10天，单位天
  refresh: 10
```

需要使用的地方

```java
	@Autowired
	private JwtUtils jwtUtils;
	
	public String getToken(CoreUser user) {
		// 创建 token
		String token = jwtUtils.createJwt(user.getUserId() + "", this.getUserRole(user.getUserId()));
		// 设置 refresh token
		int refreshTime = jwtUtils.getRefresh();
		String userInfoJson = new Gson().toJson(user);
		redisUtils.set(RedisKeys.getJwtUser(user.getUserId()), userInfoJson, refreshTime, TimeUnit.DAYS);

		return TokenConstant.TOKEN_PREFIX + token;
	}
```





##### spring boot localDateTime 序列化 反序列化

pom添加依赖

```xml
<dependency>
    <groupId>io.github.guoshiqiufeng</groupId>
    <artifactId>framework-date</artifactId>
    <version>1.2.4</version>
</dependency>
```

添加配置类

```java
package io.github.guoshiqiufeng.demo.config;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import io.github.guoshiqiufeng.date.converter.CustomDateArgumentResolverHandler;
import io.github.guoshiqiufeng.date.converter.CustomDateConverter;
import io.github.guoshiqiufeng.date.converter.CustomDateDeserializer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Map;

import static com.fasterxml.jackson.core.json.JsonReadFeature.ALLOW_BACKSLASH_ESCAPING_ANY_CHARACTER;

/**
 * 时间序列化配置
 * @author yanghq
 */
@Configuration
public class CustomDateConfig implements WebMvcConfigurer {

	@Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
	private String pattern;

	@Bean
	public LocalDateTimeSerializer localDateTimeDeserializer() {
		return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
	}

	@Bean
	public LocalDateSerializer localDateDeserializer() {
		return new LocalDateSerializer(DateTimeFormatter.ofPattern(pattern));
	}

	@Override
	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
		resolvers.add(new CustomDateArgumentResolverHandler.LocalDateArgumentResolverHandler());
	}

	@Bean
	public Converter<String, LocalDate> localDateConverter() {
		// 此处不能替换为lambda表达式
		return new CustomDateConverter.LocalDateConvert();
	}

	/**
	 * Json序列化和反序列化转换器，用于转换Post请求体中的json以及将我们的对象序列化为返回响应的json
	 */
	@Bean
	public ObjectMapper objectMapper() {
		ObjectMapper objectMapper = new ObjectMapper();
		// 不显示为null的字段
		objectMapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
		objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
		// 忽略不能转移的字符
		objectMapper.readerFor(Map.class).withFeatures(ALLOW_BACKSLASH_ESCAPING_ANY_CHARACTER);
		// 过滤对象的null属性.
		objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
		// 忽略transient
		objectMapper.configure(MapperFeature.PROPAGATE_TRANSIENT_MARKER, true);

		objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);

		// LocalDateTime系列序列化和反序列化模块，继承自jsr310，我们在这里修改了日期格式
		JavaTimeModule javaTimeModule = new JavaTimeModule();
		// LocalDateTime
		javaTimeModule.addSerializer(new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern)));
		javaTimeModule.addDeserializer(LocalDateTime.class, new CustomDateDeserializer.LocalDateTimeDeserializer());
		// LocalDate
		javaTimeModule.addSerializer(new LocalDateSerializer(DateTimeFormatter.ofPattern(pattern)));
		javaTimeModule.addDeserializer(LocalDate.class, new CustomDateDeserializer.LocalDateDeserializer());

		objectMapper.registerModule(javaTimeModule);
		return objectMapper;
	}

}

```




#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request