parent
bd50b17709
commit
83a5b921aa
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
@ -0,0 +1,20 @@
|
||||
package org.example;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
|
||||
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
|
||||
|
||||
/**
|
||||
* <h1>用户账户微服务启动入口</h1>
|
||||
* 127.0.0.1:8003/dev-protocol-springcloud-project-account-service/swagger-ui.html 原生的地址信息
|
||||
* 127.0.0.1:8003/dev-protocol-springcloud-project-account-service/doc.html 美化之后的地址信息
|
||||
* */
|
||||
@EnableJpaAuditing
|
||||
@SpringBootApplication
|
||||
@EnableDiscoveryClient
|
||||
public class AccountApplication {
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(AccountApplication.class, args);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,58 @@
|
||||
package org.example.controller;
|
||||
|
||||
import io.swagger.annotations.Api;
|
||||
import io.swagger.annotations.ApiOperation;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.example.account.AddressInfo;
|
||||
import org.example.common.TableId;
|
||||
import org.example.service.IAddressService;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
import org.springframework.web.bind.annotation.RequestBody;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
/**
|
||||
* <h1>用户地址服务 Controller</h1>
|
||||
* */
|
||||
@Api(tags = "用户地址服务")
|
||||
@Slf4j
|
||||
@RestController
|
||||
@RequestMapping("/address")
|
||||
public class AddressController {
|
||||
|
||||
private final IAddressService addressService;
|
||||
|
||||
public AddressController(IAddressService addressService) {
|
||||
this.addressService = addressService;
|
||||
}
|
||||
|
||||
// value 是简述, notes 是详细的描述信息
|
||||
@ApiOperation(value = "创建", notes = "创建用户地址信息", httpMethod = "POST")
|
||||
@PostMapping("/create-address")
|
||||
public TableId createAddressInfo(@RequestBody AddressInfo addressInfo) {
|
||||
return addressService.createAddressInfo(addressInfo);
|
||||
}
|
||||
|
||||
@ApiOperation(value = "当前用户", notes = "获取当前登录用户地址信息", httpMethod = "GET")
|
||||
@GetMapping("/current-address")
|
||||
public AddressInfo getCurrentAddressInfo() {
|
||||
return addressService.getCurrentAddressInfo();
|
||||
}
|
||||
|
||||
@ApiOperation(value = "获取用户地址信息",
|
||||
notes = "通过 id 获取用户地址信息, id 是 Address 表的主键",
|
||||
httpMethod = "GET")
|
||||
@GetMapping("/address-info")
|
||||
public AddressInfo getAddressInfoById(@RequestParam Long id) {
|
||||
return addressService.getAddressInfoById(id);
|
||||
}
|
||||
|
||||
@ApiOperation(value = "获取用户地址信息",
|
||||
notes = "通过 TableId 获取用户地址信息", httpMethod = "POST")
|
||||
@PostMapping("/address-info-by-table-id")
|
||||
public AddressInfo getAddressInfoByTablesId(@RequestBody TableId tableId) {
|
||||
return addressService.getAddressInfoByTableId(tableId);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,40 @@
|
||||
package org.example.controller;
|
||||
|
||||
import io.swagger.annotations.Api;
|
||||
import io.swagger.annotations.ApiOperation;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.example.account.BalanceInfo;
|
||||
import org.example.service.IBalanceService;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.PutMapping;
|
||||
import org.springframework.web.bind.annotation.RequestBody;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
/**
|
||||
* <h1>用户余额服务 Controller</h1>
|
||||
* */
|
||||
@Api(tags = "用户余额服务")
|
||||
@Slf4j
|
||||
@RestController
|
||||
@RequestMapping("/balance")
|
||||
public class BalanceController {
|
||||
|
||||
private final IBalanceService balanceService;
|
||||
|
||||
public BalanceController(IBalanceService balanceService) {
|
||||
this.balanceService = balanceService;
|
||||
}
|
||||
|
||||
@ApiOperation(value = "当前用户", notes = "获取当前用户余额信息", httpMethod = "GET")
|
||||
@GetMapping("/current-balance")
|
||||
public BalanceInfo getCurrentUserBalanceInfo() {
|
||||
return balanceService.getCurrentUserBalanceInfo();
|
||||
}
|
||||
|
||||
@ApiOperation(value = "扣减", notes = "扣减用于余额", httpMethod = "PUT")
|
||||
@PutMapping("/deduct-balance")
|
||||
public BalanceInfo deductBalance(@RequestBody BalanceInfo balanceInfo) {
|
||||
return balanceService.deductBalance(balanceInfo);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
package org.example.dao;
|
||||
|
||||
import org.example.entity.Address;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* <h1>EcommerceAddress Dao 接口定义</h1>
|
||||
* */
|
||||
public interface EcommerceAddressDao extends JpaRepository<Address, Long> {
|
||||
|
||||
/**
|
||||
* <h2>根据 用户 id 查询地址信息</h2>
|
||||
* */
|
||||
List<Address> findAllByUserId(Long userId);
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
package org.example.dao;
|
||||
|
||||
import org.example.entity.Balance;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
/**
|
||||
* <h1>Balance Dao 接口定义</h1>
|
||||
* */
|
||||
public interface EcommerceBalanceDao extends JpaRepository<Balance, Long> {
|
||||
|
||||
/** 根据 userId 查询 EcommerceBalance 对象 */
|
||||
Balance findByUserId(Long userId);
|
||||
}
|
||||
@ -0,0 +1,106 @@
|
||||
package org.example.entity;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.example.account.AddressInfo;
|
||||
import org.springframework.data.annotation.CreatedDate;
|
||||
import org.springframework.data.annotation.LastModifiedDate;
|
||||
import org.springframework.data.jpa.domain.support.AuditingEntityListener;
|
||||
|
||||
import javax.persistence.Column;
|
||||
import javax.persistence.Entity;
|
||||
import javax.persistence.EntityListeners;
|
||||
import javax.persistence.GeneratedValue;
|
||||
import javax.persistence.GenerationType;
|
||||
import javax.persistence.Id;
|
||||
import javax.persistence.Table;
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* <h1>用户地址表实体类定义</h1>
|
||||
* */
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Entity
|
||||
@EntityListeners(AuditingEntityListener.class)
|
||||
@Table(name = "t_dev_protocol_cloud_address")
|
||||
public class Address {
|
||||
|
||||
/** 自增主键 */
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
@Column(name = "id", nullable = false)
|
||||
private Long id;
|
||||
|
||||
/** 用户 id */
|
||||
@Column(name = "user_id", nullable = false)
|
||||
private Long userId;
|
||||
|
||||
/** 用户名 */
|
||||
@Column(name = "username", nullable = false)
|
||||
private String username;
|
||||
|
||||
/** 电话 */
|
||||
@Column(name = "phone", nullable = false)
|
||||
private String phone;
|
||||
|
||||
/** 省 */
|
||||
@Column(name = "province", nullable = false)
|
||||
private String province;
|
||||
|
||||
/** 市 */
|
||||
@Column(name = "city", nullable = false)
|
||||
private String city;
|
||||
|
||||
/** 详细地址 */
|
||||
@Column(name = "address_detail", nullable = false)
|
||||
private String addressDetail;
|
||||
|
||||
/** 创建时间 */
|
||||
@CreatedDate
|
||||
@Column(name = "create_time", nullable = false)
|
||||
private Date createTime;
|
||||
|
||||
/** 更新时间 */
|
||||
@LastModifiedDate
|
||||
@Column(name = "update_time", nullable = false)
|
||||
private Date updateTime;
|
||||
|
||||
/**
|
||||
* <h2>根据 userId + AddressItem 得到 Address</h2>
|
||||
* */
|
||||
public static Address to(Long userId, AddressInfo.AddressItem addressItem) {
|
||||
|
||||
Address ecommerceAddress = new Address();
|
||||
|
||||
ecommerceAddress.setUserId(userId);
|
||||
ecommerceAddress.setUsername(addressItem.getUsername());
|
||||
ecommerceAddress.setPhone(addressItem.getPhone());
|
||||
ecommerceAddress.setProvince(addressItem.getProvince());
|
||||
ecommerceAddress.setCity(addressItem.getCity());
|
||||
ecommerceAddress.setAddressDetail(addressItem.getAddressDetail());
|
||||
|
||||
return ecommerceAddress;
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>将 Address 对象转成 AddressInfo</h2>
|
||||
* */
|
||||
public AddressInfo.AddressItem toAddressItem() {
|
||||
|
||||
AddressInfo.AddressItem addressItem = new AddressInfo.AddressItem();
|
||||
|
||||
addressItem.setId(this.id);
|
||||
addressItem.setUsername(this.username);
|
||||
addressItem.setPhone(this.phone);
|
||||
addressItem.setProvince(this.province);
|
||||
addressItem.setCity(this.city);
|
||||
addressItem.setAddressDetail(this.addressDetail);
|
||||
addressItem.setCreateTime(this.createTime);
|
||||
addressItem.setUpdateTime(this.updateTime);
|
||||
|
||||
return addressItem;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,53 @@
|
||||
package org.example.entity;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.springframework.data.annotation.CreatedDate;
|
||||
import org.springframework.data.annotation.LastModifiedDate;
|
||||
import org.springframework.data.jpa.domain.support.AuditingEntityListener;
|
||||
|
||||
import javax.persistence.Column;
|
||||
import javax.persistence.Entity;
|
||||
import javax.persistence.EntityListeners;
|
||||
import javax.persistence.GeneratedValue;
|
||||
import javax.persistence.GenerationType;
|
||||
import javax.persistence.Id;
|
||||
import javax.persistence.Table;
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* <h1>用户账户余额表实体类定义</h1>
|
||||
* */
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Entity
|
||||
@EntityListeners(AuditingEntityListener.class)
|
||||
@Table(name = "t_dev_protocol_cloud_balance")
|
||||
public class Balance {
|
||||
|
||||
/** 自增主键 */
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
@Column(name = "id", nullable = false)
|
||||
private Long id;
|
||||
|
||||
/** 用户 id */
|
||||
@Column(name = "user_id", nullable = false)
|
||||
private Long userId;
|
||||
|
||||
/** 账户余额 */
|
||||
@Column(name = "balance", nullable = false)
|
||||
private Long balance;
|
||||
|
||||
/** 创建时间 */
|
||||
@CreatedDate
|
||||
@Column(name = "create_time", nullable = false)
|
||||
private Date createTime;
|
||||
|
||||
/** 更新时间 */
|
||||
@LastModifiedDate
|
||||
@Column(name = "update_time", nullable = false)
|
||||
private Date updateTime;
|
||||
}
|
||||
@ -0,0 +1,31 @@
|
||||
package org.example.service;
|
||||
|
||||
|
||||
import org.example.account.AddressInfo;
|
||||
import org.example.common.TableId;
|
||||
|
||||
/**
|
||||
* <h1>用户地址相关服务接口定义</h1>
|
||||
* */
|
||||
public interface IAddressService {
|
||||
|
||||
/**
|
||||
* <h2>创建用户地址信息</h2>
|
||||
* */
|
||||
TableId createAddressInfo(AddressInfo addressInfo);
|
||||
|
||||
/**
|
||||
* <h2>获取当前登录的用户地址信息</h2>
|
||||
* */
|
||||
AddressInfo getCurrentAddressInfo();
|
||||
|
||||
/**
|
||||
* <h2>通过 id 获取用户地址信息, id 是 Address 表的主键</h2>
|
||||
* */
|
||||
AddressInfo getAddressInfoById(Long id);
|
||||
|
||||
/**
|
||||
* <h2>通过 TableId 获取用户地址信息</h2>
|
||||
* */
|
||||
AddressInfo getAddressInfoByTableId(TableId tableId);
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
package org.example.service;
|
||||
|
||||
|
||||
import org.example.account.BalanceInfo;
|
||||
|
||||
/**
|
||||
* <h2>用于余额相关的服务接口定义</h2>
|
||||
* */
|
||||
public interface IBalanceService {
|
||||
|
||||
/**
|
||||
* <h2>获取当前用户余额信息</h2>
|
||||
* */
|
||||
BalanceInfo getCurrentUserBalanceInfo();
|
||||
|
||||
/**
|
||||
* <h2>扣减用户余额</h2>
|
||||
* @param balanceInfo 代表想要扣减的余额
|
||||
* */
|
||||
BalanceInfo deductBalance(BalanceInfo balanceInfo);
|
||||
}
|
||||
@ -0,0 +1,110 @@
|
||||
package org.example.service.impl;
|
||||
|
||||
import com.alibaba.fastjson2.JSON;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.apache.commons.collections4.CollectionUtils;
|
||||
import org.example.account.AddressInfo;
|
||||
import org.example.common.TableId;
|
||||
import org.example.dao.EcommerceAddressDao;
|
||||
import org.example.entity.Address;
|
||||
import org.example.filter.AccessContext;
|
||||
import org.example.service.IAddressService;
|
||||
import org.example.vo.LoginUserInfo;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.transaction.annotation.Transactional;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
/**
|
||||
* <h1>用户地址相关服务接口实现</h1>
|
||||
* */
|
||||
@Slf4j
|
||||
@Service
|
||||
@Transactional(rollbackFor = Exception.class)
|
||||
public class AddressServiceImpl implements IAddressService {
|
||||
|
||||
private final EcommerceAddressDao addressDao;
|
||||
|
||||
public AddressServiceImpl(EcommerceAddressDao addressDao) {
|
||||
this.addressDao = addressDao;
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>存储多个地址信息</h2>
|
||||
* */
|
||||
@Override
|
||||
public TableId createAddressInfo(AddressInfo addressInfo) {
|
||||
|
||||
// 不能直接从参数中获取用户的 id 信息
|
||||
LoginUserInfo loginUserInfo = AccessContext.getLoginUserInfo();
|
||||
|
||||
// 将传递的参数转换成实体对象
|
||||
List<Address> ecommerceAddresses = addressInfo.getAddressItems().stream()
|
||||
.map(a -> Address.to(loginUserInfo.getId(), a))
|
||||
.collect(Collectors.toList());
|
||||
|
||||
// 保存到数据表并把返回记录的 id 给调用方
|
||||
List<Address> savedRecords = addressDao.saveAll(ecommerceAddresses);
|
||||
List<Long> ids = savedRecords.stream()
|
||||
.map(Address::getId).collect(Collectors.toList());
|
||||
log.info("create address info: [{}], [{}]", loginUserInfo.getId(),
|
||||
JSON.toJSONString(ids));
|
||||
|
||||
return new TableId(
|
||||
ids.stream().map(TableId.Id::new).collect(Collectors.toList())
|
||||
);
|
||||
}
|
||||
|
||||
@Override
|
||||
public AddressInfo getCurrentAddressInfo() {
|
||||
|
||||
LoginUserInfo loginUserInfo = AccessContext.getLoginUserInfo();
|
||||
|
||||
// 根据 userId 查询到用户的地址信息, 再实现转换
|
||||
List<Address> ecommerceAddresses = addressDao.findAllByUserId(
|
||||
loginUserInfo.getId()
|
||||
);
|
||||
List<AddressInfo.AddressItem> addressItems = ecommerceAddresses.stream()
|
||||
.map(Address::toAddressItem)
|
||||
.collect(Collectors.toList());
|
||||
|
||||
return new AddressInfo(loginUserInfo.getId(), addressItems);
|
||||
}
|
||||
|
||||
@Override
|
||||
public AddressInfo getAddressInfoById(Long id) {
|
||||
|
||||
Address ecommerceAddress = addressDao.findById(id).orElse(null);
|
||||
if (null == ecommerceAddress) {
|
||||
throw new RuntimeException("address is not exist");
|
||||
}
|
||||
|
||||
return new AddressInfo(
|
||||
ecommerceAddress.getUserId(),
|
||||
Collections.singletonList(ecommerceAddress.toAddressItem())
|
||||
);
|
||||
}
|
||||
|
||||
@Override
|
||||
public AddressInfo getAddressInfoByTableId(TableId tableId) {
|
||||
|
||||
List<Long> ids = tableId.getIds().stream()
|
||||
.map(TableId.Id::getId).collect(Collectors.toList());
|
||||
log.info("get address info by table id: [{}]", JSON.toJSONString(ids));
|
||||
|
||||
List<Address> ecommerceAddresses = addressDao.findAllById(ids);
|
||||
if (CollectionUtils.isEmpty(ecommerceAddresses)) {
|
||||
return new AddressInfo(-1L, Collections.emptyList());
|
||||
}
|
||||
|
||||
List<AddressInfo.AddressItem> addressItems = ecommerceAddresses.stream()
|
||||
.map(Address::toAddressItem)
|
||||
.collect(Collectors.toList());
|
||||
|
||||
return new AddressInfo(
|
||||
ecommerceAddresses.get(0).getUserId(), addressItems
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
server:
|
||||
port: 8003
|
||||
servlet:
|
||||
context-path: /dev-protocol-springcloud-project-account-service
|
||||
|
||||
spring:
|
||||
application:
|
||||
name: dev-protocol-springcloud-project-account-service
|
||||
cloud:
|
||||
nacos:
|
||||
discovery:
|
||||
enabled: true # 如果不想使用 Nacos 进行服务注册和发现, 设置为 false 即可
|
||||
server-addr: 127.0.0.1:8848
|
||||
# server-addr: 127.0.0.1:8848,127.0.0.1:8849,127.0.0.1:8850 # Nacos 服务器地址
|
||||
namespace: 1ccc74ae-9398-4dbe-b9d7-4f9addf9f40c
|
||||
metadata:
|
||||
management:
|
||||
context-path: ${server.servlet.context-path}/actuator
|
||||
kafka:
|
||||
bootstrap-servers: 127.0.0.1:9092
|
||||
producer:
|
||||
retries: 3
|
||||
consumer:
|
||||
auto-offset-reset: latest
|
||||
sleuth:
|
||||
sampler:
|
||||
probability: 1.0 # 采样比例, 1.0 表示 100%, 默认是 0.1
|
||||
zipkin:
|
||||
sender:
|
||||
type: kafka # 默认是 web
|
||||
base-url: http://localhost:9411/
|
||||
jpa:
|
||||
show-sql: true
|
||||
hibernate:
|
||||
ddl-auto: none
|
||||
properties:
|
||||
hibernate.show_sql: true
|
||||
hibernate.format_sql: true
|
||||
hibernate:
|
||||
dialect: org.hibernate.dialect.MySQLDialect
|
||||
open-in-view: false
|
||||
datasource:
|
||||
# 数据源
|
||||
url: jdbc:mysql://127.0.0.1:3306/dev_protocol_springcloud_project?autoReconnect=true&useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8
|
||||
username: root
|
||||
password: root
|
||||
type: com.zaxxer.hikari.HikariDataSource
|
||||
driver-class-name: com.mysql.cj.jdbc.Driver
|
||||
# 连接池
|
||||
hikari:
|
||||
maximum-pool-size: 8
|
||||
minimum-idle: 4
|
||||
idle-timeout: 30000
|
||||
connection-timeout: 30000
|
||||
max-lifetime: 45000
|
||||
auto-commit: true
|
||||
pool-name: devProtocolSpringcloudHikariCP
|
||||
|
||||
# 暴露端点
|
||||
management:
|
||||
endpoints:
|
||||
web:
|
||||
exposure:
|
||||
include: '*'
|
||||
endpoint:
|
||||
health:
|
||||
show-details: always
|
||||
@ -0,0 +1,43 @@
|
||||
### 创建用户地址信息
|
||||
POST http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/address/create-address
|
||||
Content-Type: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
{
|
||||
"userId": 10,
|
||||
"addressItems": [
|
||||
{
|
||||
"username": "zxcx",
|
||||
"phone": "16600000001",
|
||||
"province": "上海市",
|
||||
"city": "上海市",
|
||||
"addressDetail": "闵行区"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
### 当前登录用户地址信息
|
||||
GET http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/address/current-address
|
||||
Accept: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
### 通过 id 获取用户地址信息
|
||||
GET http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/address/address-info?id=2
|
||||
Accept: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
### 获取用户地址信息
|
||||
POST http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/address/address-info-by-table-id
|
||||
Content-Type: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
{
|
||||
"ids": [
|
||||
{
|
||||
"id": 1
|
||||
},
|
||||
{
|
||||
"id": 2
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
### 获取当前用户余额信息
|
||||
GET http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/balance/current-balance
|
||||
Accept: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
### 扣减用户余额
|
||||
PUT http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/balance/deduct-balance
|
||||
Content-Type: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjEwLFwidXNlcm5hbWVcIjpcIlFpbnlpQGltb29jLmNvbVwifSIsImp0aSI6IjU2ZGViY2NiLTlkNTEtNDMzMC04NjFhLTY5MWI0YWE2NzY1MiIsImV4cCI6MTYyNDcyMzIwMH0.M9Xg__zvXvAeALMcAs1LIJN41_JGo7Od1bw0218AbmzrBMZ-9WT6plow62gSBfxa5Xbm79t6VeHq8iC7a0ZYBF2RemNaXmrgIkmwxjg12jO56hTCRv1jghAbiFZknTxXA4QQ6dB3MS4mE19MDt6P3f3ckLwyl-IjE9O5_c-wg47Sb8odfrm_K2RMx_2ZMQAfNjHzxCzrQyNRWhqSQTpSVAuUScaxlnf4EvEwav8FT0QICIlx8oZyU7fh_zBtfFL4EhQlHfcU-eo6Nw4YUVA0knIrkAXD8jqCowx7Mej8khQ6zXNUB2V_uTtc2P2VW1UHlWSAiFCR_qkvBGSWO0VH_w
|
||||
|
||||
{
|
||||
"userId": 10,
|
||||
"balance": 2000
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
-- 创建 t_ecommerce_address 数据表
|
||||
CREATE TABLE IF NOT EXISTS `dev_protocol_springcloud_project`.`t_dev_protocol_cloud_address` (
|
||||
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '自增主键',
|
||||
`user_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '用户 id',
|
||||
`username` varchar(64) NOT NULL DEFAULT '' COMMENT '用户名',
|
||||
`phone` varchar(64) NOT NULL DEFAULT '' COMMENT '电话号码',
|
||||
`province` varchar(64) NOT NULL DEFAULT '' COMMENT '省',
|
||||
`city` varchar(64) NOT NULL DEFAULT '' COMMENT '市',
|
||||
`address_detail` varchar(256) NOT NULL DEFAULT '' COMMENT '详细地址',
|
||||
`create_time` datetime NOT NULL DEFAULT '0000-01-01 00:00:00' COMMENT '创建时间',
|
||||
`update_time` datetime NOT NULL DEFAULT '0000-01-01 00:00:00' COMMENT '更新时间',
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='用户地址表';
|
||||
@ -0,0 +1,10 @@
|
||||
-- 创建 t_ecommerce_balance 数据表
|
||||
CREATE TABLE IF NOT EXISTS `dev_protocol_springcloud_project`.`t_dev_protocol_cloud_balance` (
|
||||
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '自增主键',
|
||||
`user_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '用户 id',
|
||||
`balance` bigint(20) NOT NULL DEFAULT 0 COMMENT '账户余额',
|
||||
`create_time` datetime NOT NULL DEFAULT '0000-01-01 00:00:00' COMMENT '创建时间',
|
||||
`update_time` datetime NOT NULL DEFAULT '0000-01-01 00:00:00' COMMENT '更新时间',
|
||||
PRIMARY KEY (`id`),
|
||||
UNIQUE KEY `user_id_key` (`user_id`)
|
||||
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='用户账户余额表';
|
||||
@ -0,0 +1,19 @@
|
||||
package org.example;
|
||||
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
/**
|
||||
* <h1>用户账户微服务环境可用性校验</h1>
|
||||
* */
|
||||
@SpringBootTest
|
||||
@RunWith(SpringRunner.class)
|
||||
public class AccountApplicationTest {
|
||||
|
||||
@Test
|
||||
public void contextLoad() {
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,76 @@
|
||||
package org.example.service;
|
||||
|
||||
import com.alibaba.fastjson2.JSON;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.example.account.AddressInfo;
|
||||
import org.example.common.TableId;
|
||||
import org.junit.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
|
||||
import java.util.Collections;
|
||||
|
||||
/**
|
||||
* <h1>用户地址相关服务功能测试</h1>
|
||||
* */
|
||||
@Slf4j
|
||||
public class AddressServiceTest extends BaseTest {
|
||||
|
||||
@Autowired
|
||||
private IAddressService addressService;
|
||||
|
||||
/**
|
||||
* <h2>测试创建用户地址信息</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testCreateAddressInfo() {
|
||||
|
||||
AddressInfo.AddressItem addressItem = new AddressInfo.AddressItem();
|
||||
addressItem.setUsername("qqq");
|
||||
addressItem.setPhone("18800000001");
|
||||
addressItem.setProvince("上海市");
|
||||
addressItem.setCity("上海市");
|
||||
addressItem.setAddressDetail("陆家嘴");
|
||||
|
||||
log.info("test create address info: [{}]", JSON.toJSONString(
|
||||
addressService.createAddressInfo(
|
||||
new AddressInfo(loginUserInfo.getId(),
|
||||
Collections.singletonList(addressItem))
|
||||
)
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>测试获取当前登录用户地址信息</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testGetCurrentAddressInfo() {
|
||||
|
||||
log.info("test get current user info: [{}]", JSON.toJSONString(
|
||||
addressService.getCurrentAddressInfo()
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>测试通过 id 获取用户地址信息</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testGetAddressInfoById() {
|
||||
|
||||
log.info("test get address info by id: [{}]", JSON.toJSONString(
|
||||
addressService.getAddressInfoById(1L)
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>测试通过 TableId 获取用户地址信息</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testGetAddressInfoByTableId() {
|
||||
|
||||
log.info("test get address info by table id: [{}]", JSON.toJSONString(
|
||||
addressService.getAddressInfoByTableId(
|
||||
new TableId(Collections.singletonList(new TableId.Id(1L)))
|
||||
)
|
||||
));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
package org.example.service;
|
||||
|
||||
import com.alibaba.fastjson2.JSON;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.example.account.BalanceInfo;
|
||||
import org.junit.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
|
||||
/**
|
||||
* <h1>用于余额相关服务测试</h1>
|
||||
* */
|
||||
@Slf4j
|
||||
public class BalanceServiceTest extends BaseTest {
|
||||
|
||||
@Autowired
|
||||
private IBalanceService balanceService;
|
||||
|
||||
/**
|
||||
* <h2>测试获取当前用户的余额信息</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testGetCurrentUserBalanceInfo() {
|
||||
|
||||
log.info("test get current user balance info: [{}]", JSON.toJSONString(
|
||||
balanceService.getCurrentUserBalanceInfo()
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>测试扣减用于余额</h2>
|
||||
* */
|
||||
@Test
|
||||
public void testDeductBalance() {
|
||||
|
||||
BalanceInfo balanceInfo = new BalanceInfo();
|
||||
balanceInfo.setUserId(loginUserInfo.getId());
|
||||
balanceInfo.setBalance(1000L);
|
||||
|
||||
log.info("test deduct balance: [{}]", JSON.toJSONString(
|
||||
balanceService.deductBalance(balanceInfo)
|
||||
));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,31 @@
|
||||
package org.example.service;
|
||||
|
||||
import org.example.filter.AccessContext;
|
||||
import org.example.vo.LoginUserInfo;
|
||||
import org.junit.After;
|
||||
import org.junit.Before;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
/**
|
||||
* <h1>测试用例基类, 填充登录用户信息</h1>
|
||||
* */
|
||||
@SpringBootTest
|
||||
@RunWith(SpringRunner.class)
|
||||
public abstract class BaseTest {
|
||||
|
||||
protected final LoginUserInfo loginUserInfo = new LoginUserInfo(
|
||||
10L, "q@bbbbbbyyyyyy.com"
|
||||
);
|
||||
|
||||
@Before
|
||||
public void init() {
|
||||
AccessContext.setLoginUserInfo(loginUserInfo);
|
||||
}
|
||||
|
||||
@After
|
||||
public void destroy() {
|
||||
AccessContext.clearLoginUserInfo();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,80 @@
|
||||
## 用户账户微服务
|
||||
|
||||
### 用户身份登录统一拦截
|
||||
- 所有需要开发的微服务通用的配置
|
||||
|
||||
### 集成 Swagger2 实现代码即文档
|
||||
-
|
||||
|
||||
### 用户账户微服务功能设计
|
||||
-
|
||||
|
||||
### 数据表及 ORM 过程
|
||||
-
|
||||
|
||||
### 用户地址与余额服务接口定义
|
||||
- Service 返回包装成类进行返回, 尽量不要仅仅只返回一个ID, 防止后续的扩展需求
|
||||
- 不要设计通过请求参数来获取当前用户的余额信息, 因为可以通过请求劫持来拿到别的请求信息, 防止越权
|
||||
### 用户地址相关服务接口实现
|
||||
|
||||
|
||||
### 用户地址服务接口可用性测试（测试用例）
|
||||
|
||||
|
||||
### 用户余额相关服务接口实现
|
||||
|
||||
|
||||
### 用户余额服务接口可用性测试（测试用例）
|
||||
|
||||
|
||||
### 用户账户微服务对外 HTTP 接口
|
||||
|
||||
|
||||
### 验证用户账户微服务功能可用性
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "dev-protocol-springcloud-project-account-service",
|
||||
"order": 0, // order 越小优先级越高0
|
||||
"predicates": [
|
||||
{
|
||||
"args": {
|
||||
"pattern": "/dev-protocol-springcloud-gateway/dev-protocol-springcloud-project-account-service/**"
|
||||
},
|
||||
"name": "Path"
|
||||
}
|
||||
],
|
||||
"uri": "lb://dev-protocol-springcloud-project-account-service",
|
||||
"filters": [
|
||||
{
|
||||
"name": "HeaderToken"
|
||||
},
|
||||
{
|
||||
"name": "StripPrefix",
|
||||
"args": {
|
||||
"parts": "1" // 用来跳过上面的 pattern 前面的配置, 因为 [bootstrap.yml] 中的配置 context-path
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
- 补充放在nacos 的 gateway 的配置文件中
|
||||
### 用户账户微服务总结
|
||||
|
||||
- 微服务开始之前的准备工作
|
||||
- 用户身份登录拦截
|
||||
- 在请求进入 service 之前解析 header 中的 token 信息, 并填充用户信息到上下文中
|
||||
- 在请求结束之后,清理掉上下文中的用户信息
|
||||
- 对于一些特定的 HTTP 请求不要拦截(即白名单 )
|
||||
- 代码即文档:引入 Swagger
|
||||
- pom 中添加依赖配置
|
||||
- 自定义配置 Swagger
|
||||
---
|
||||
- 微服务模块的设计思想
|
||||
- 微服务模块应该是低耦合、尽可能多的重用代码
|
||||
- Tips:设计并不唯-!
|
||||
- 
|
||||
---
|
||||
- 用户账户微服务的功能及在业务中的位置
|
||||
- 
|
||||
@ -0,0 +1,6 @@
|
||||
# 介绍
|
||||
- 正常服务的通用配置
|
||||
- 开发别的模块也要直接进行导入
|
||||
|
||||
# 已实现功能
|
||||
- 统一身份拦截器
|
||||
@ -0,0 +1,51 @@
|
||||
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.example</groupId>
|
||||
<artifactId>dev-protocol</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
<artifactId>dev-protocol-springcloud-project-service-config</artifactId>
|
||||
|
||||
<!-- 模块名及描述信息 -->
|
||||
<name>dev-protocol-springcloud-project-service-config</name>
|
||||
<description>服务通用配置</description>
|
||||
|
||||
<properties>
|
||||
<maven.compiler.source>8</maven.compiler.source>
|
||||
<maven.compiler.target>8</maven.compiler.target>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.example</groupId>
|
||||
<artifactId>dev-protocol-springcloud-project-mvc-config</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
</dependency>
|
||||
|
||||
<!-- swagger 用于定义 API 文档 -->
|
||||
<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>
|
||||
<!-- 美化 swagger -->
|
||||
<dependency>
|
||||
<groupId>com.github.xiaoymin</groupId>
|
||||
<artifactId>swagger-bootstrap-ui</artifactId>
|
||||
<version>1.9.3</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
||||
@ -0,0 +1,44 @@
|
||||
package org.example.conf;
|
||||
|
||||
import org.example.filter.LoginUserInfoInterceptor;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
|
||||
|
||||
/**
|
||||
* <h1>Web Mvc 配置</h1>
|
||||
* */
|
||||
@Configuration
|
||||
@SuppressWarnings("all")
|
||||
public class DevProtocolWebMvcConfig extends WebMvcConfigurationSupport {
|
||||
|
||||
/**
|
||||
* <h2>添加拦截器配置</h2>
|
||||
* */
|
||||
@Override
|
||||
protected void addInterceptors(InterceptorRegistry registry) {
|
||||
|
||||
// 添加用户身份统一登录拦截的拦截器
|
||||
registry.addInterceptor(new LoginUserInfoInterceptor())
|
||||
.addPathPatterns("/**").order(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>让 MVC 加载 Swagger 的静态资源</h2>
|
||||
* */
|
||||
@Override
|
||||
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
|
||||
|
||||
registry.addResourceHandler("/**").
|
||||
addResourceLocations("classpath:/static/");
|
||||
registry.addResourceHandler("swagger-ui.html")
|
||||
.addResourceLocations("classpath:/META-INF/resources/");
|
||||
registry.addResourceHandler("doc.html")
|
||||
.addResourceLocations("classpath:/META-INF/resources/");
|
||||
registry.addResourceHandler("/webjars/**")
|
||||
.addResourceLocations("classpath:/META-INF/resources/webjars/");
|
||||
|
||||
super.addResourceHandlers(registry);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,56 @@
|
||||
package org.example.conf;
|
||||
|
||||
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.Contact;
|
||||
import springfox.documentation.spi.DocumentationType;
|
||||
import springfox.documentation.spring.web.plugins.Docket;
|
||||
import springfox.documentation.swagger2.annotations.EnableSwagger2;
|
||||
|
||||
/**
|
||||
* <h1>Swagger 配置类</h1>
|
||||
* 原生: /swagger-ui.html
|
||||
* 美化: /doc.html
|
||||
* */
|
||||
@Configuration
|
||||
@EnableSwagger2
|
||||
@SuppressWarnings("all")
|
||||
public class SwaggerConfig {
|
||||
|
||||
/**
|
||||
* <h2>Swagger 实例 Bean 是 Docket, 所以通过配置 Docket 实例来配置 Swagger</h2>
|
||||
* */
|
||||
@Bean
|
||||
public Docket docket() {
|
||||
|
||||
return new Docket(DocumentationType.SWAGGER_2)
|
||||
// 展示在 Swagger 页面上的自定义工程描述信息
|
||||
.apiInfo(apiInfo())
|
||||
// 选择展示哪些接口
|
||||
.select()
|
||||
// 只有 org.example 包内的才去展示
|
||||
// fixme 这个可以后续进行把一些不展示的接口进行规避
|
||||
.apis(RequestHandlerSelectors.basePackage("org.example"))
|
||||
.paths(PathSelectors.any())
|
||||
.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>Swagger 的描述信息</h2>
|
||||
* */
|
||||
public ApiInfo apiInfo() {
|
||||
|
||||
return new ApiInfoBuilder()
|
||||
.title("dev-protocol-micro-service")
|
||||
.description("dev-protocol-springcloud-project")
|
||||
.contact(new Contact(
|
||||
"q", "www.q.com", "q@by.com"
|
||||
))
|
||||
.version("1.0")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,25 @@
|
||||
package org.example.filter;
|
||||
|
||||
import org.example.vo.LoginUserInfo;
|
||||
|
||||
/**
|
||||
* <h1>使用 ThreadLocal 去单独存储每一个线程携带的 LoginUserInfo 信息</h1>
|
||||
* 要及时的清理我们保存到 ThreadLocal 中的用户信息:
|
||||
* 1. 保证没有资源泄露
|
||||
* 2. 保证线程在重用时, 不会出现数据混乱
|
||||
* */
|
||||
public class AccessContext {
|
||||
private static final ThreadLocal<LoginUserInfo> loginUserInfo = new ThreadLocal<>();
|
||||
|
||||
public static LoginUserInfo getLoginUserInfo() {
|
||||
return loginUserInfo.get();
|
||||
}
|
||||
|
||||
public static void setLoginUserInfo(LoginUserInfo loginUserInfo_) {
|
||||
loginUserInfo.set(loginUserInfo_);
|
||||
}
|
||||
|
||||
public static void clearLoginUserInfo() {
|
||||
loginUserInfo.remove();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,84 @@
|
||||
package org.example.filter;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.example.constant.CommonConstant;
|
||||
import org.example.utils.TokenParseUtils;
|
||||
import org.example.vo.LoginUserInfo;
|
||||
import org.springframework.stereotype.Component;
|
||||
import org.springframework.web.servlet.HandlerInterceptor;
|
||||
import org.springframework.web.servlet.ModelAndView;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
/**
|
||||
* <h1>用户身份统一登录拦截</h1>
|
||||
* */
|
||||
@SuppressWarnings("all")
|
||||
@Slf4j
|
||||
@Component
|
||||
public class LoginUserInfoInterceptor implements HandlerInterceptor {
|
||||
|
||||
@Override
|
||||
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
|
||||
Object handler) throws Exception {
|
||||
|
||||
// 部分请求不需要带有身份信息, 即白名单
|
||||
if (checkWhiteListUrl(request.getRequestURI())) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// 先尝试从 http header 里面拿到 token
|
||||
String token = request.getHeader(CommonConstant.JWT_USER_INFO_KEY);
|
||||
|
||||
LoginUserInfo loginUserInfo = null;
|
||||
try {
|
||||
loginUserInfo = TokenParseUtils.parseUserInfoFromToken(token);
|
||||
} catch (Exception ex) {
|
||||
log.error("parse login user info error: [{}]", ex.getMessage(), ex);
|
||||
}
|
||||
|
||||
// 如果程序走到这里, 说明 header 中没有 token 信息
|
||||
if (null == loginUserInfo) {
|
||||
throw new RuntimeException("can not parse current login user");
|
||||
}
|
||||
|
||||
log.info("set login user info: [{}]", request.getRequestURI());
|
||||
// 设置当前请求上下文, 把用户信息填充进去
|
||||
AccessContext.setLoginUserInfo(loginUserInfo);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void postHandle(HttpServletRequest request, HttpServletResponse response,
|
||||
Object handler, ModelAndView modelAndView) throws Exception {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>在请求完全结束后调用, 常用于清理资源等工作</h2>
|
||||
* */
|
||||
@Override
|
||||
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
|
||||
Object handler, Exception ex) throws Exception {
|
||||
|
||||
if (null != AccessContext.getLoginUserInfo()) {
|
||||
AccessContext.clearLoginUserInfo();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>校验是否是白名单接口</h2>
|
||||
* swagger2 接口
|
||||
* */
|
||||
private boolean checkWhiteListUrl(String url) {
|
||||
|
||||
return StringUtils.containsAny(
|
||||
url,
|
||||
"springfox", "swagger", "v2",
|
||||
"webjars", "doc.html"
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
package org.example;
|
||||
@ -0,0 +1,6 @@
|
||||
# 介绍
|
||||
- 供数据传输的数据结构, 以及转换方式
|
||||
- 开发别的模块也要直接进行导入
|
||||
|
||||
# 已加入实体
|
||||
- 账号微服务 sdk
|
||||
@ -0,0 +1,52 @@
|
||||
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.example</groupId>
|
||||
<artifactId>dev-protocol</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
<artifactId>dev-protocol-springcloud-project-service-sdk</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<!-- 模块名及描述信息 -->
|
||||
<name>dev-protocol-springcloud-project-service-sdk</name>
|
||||
<description>服务模块 SDK</description>
|
||||
|
||||
<properties>
|
||||
<maven.compiler.source>8</maven.compiler.source>
|
||||
<maven.compiler.target>8</maven.compiler.target>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<!-- swagger 用于定义 API 文档 -->
|
||||
<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>
|
||||
<!-- 美化 swagger -->
|
||||
<dependency>
|
||||
<groupId>com.github.xiaoymin</groupId>
|
||||
<artifactId>swagger-bootstrap-ui</artifactId>
|
||||
<version>1.9.3</version>
|
||||
</dependency>
|
||||
<!-- lombok 工具通过在代码编译时期动态的将注解替换为具体的代码,
|
||||
IDEA 需要添加 lombok 插件 -->
|
||||
<dependency>
|
||||
<groupId>org.projectlombok</groupId>
|
||||
<artifactId>lombok</artifactId>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
||||
@ -0,0 +1,80 @@
|
||||
package org.example.account;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
import java.util.Date;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* <h1>用户地址信息</h1>
|
||||
* */
|
||||
@ApiModel(description = "用户地址信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class AddressInfo {
|
||||
|
||||
@ApiModelProperty(value = "地址所属用户 id")
|
||||
private Long userId;
|
||||
|
||||
@ApiModelProperty(value = "地址详细信息")
|
||||
private List<AddressItem> addressItems;
|
||||
|
||||
/**
|
||||
* <h2>单个的地址信息</h2>
|
||||
* */
|
||||
@ApiModel(description = "用户的单个地址信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public static class AddressItem {
|
||||
|
||||
@ApiModelProperty(value = "地址表主键 id")
|
||||
private Long id;
|
||||
|
||||
@ApiModelProperty(value = "用户姓名")
|
||||
private String username;
|
||||
|
||||
@ApiModelProperty(value = "电话")
|
||||
private String phone;
|
||||
|
||||
@ApiModelProperty(value = "省")
|
||||
private String province;
|
||||
|
||||
@ApiModelProperty(value = "市")
|
||||
private String city;
|
||||
|
||||
@ApiModelProperty(value = "详细的地址")
|
||||
private String addressDetail;
|
||||
|
||||
@ApiModelProperty(value = "创建时间")
|
||||
private Date createTime;
|
||||
|
||||
@ApiModelProperty(value = "更新时间")
|
||||
private Date updateTime;
|
||||
|
||||
public AddressItem(Long id) {
|
||||
this.id = id;
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>将 AddressItem 转换成 UserAddress</h2>
|
||||
* */
|
||||
public UserAddress toUserAddress() {
|
||||
|
||||
UserAddress userAddress = new UserAddress();
|
||||
|
||||
userAddress.setUsername(this.username);
|
||||
userAddress.setPhone(this.phone);
|
||||
userAddress.setProvince(this.province);
|
||||
userAddress.setCity(this.city);
|
||||
userAddress.setAddressDetail(this.addressDetail);
|
||||
|
||||
return userAddress;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,23 @@
|
||||
package org.example.account;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
/**
|
||||
* <h1>用户账户余额信息</h1>
|
||||
* */
|
||||
@ApiModel(description = "用户账户余额信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class BalanceInfo {
|
||||
|
||||
@ApiModelProperty(value = "用户主键 id")
|
||||
private Long userId;
|
||||
|
||||
@ApiModelProperty(value = "用户账户余额")
|
||||
private Long balance;
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
package org.example.account;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
/**
|
||||
* <h1>用户地址信息</h1>
|
||||
* */
|
||||
@ApiModel(description = "用户地址信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class UserAddress {
|
||||
|
||||
@ApiModelProperty(value = "用户姓名")
|
||||
private String username;
|
||||
|
||||
@ApiModelProperty(value = "电话")
|
||||
private String phone;
|
||||
|
||||
@ApiModelProperty(value = "省")
|
||||
private String province;
|
||||
|
||||
@ApiModelProperty(value = "市")
|
||||
private String city;
|
||||
|
||||
@ApiModelProperty(value = "详细的地址")
|
||||
private String addressDetail;
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
package org.example.common;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* <h1>主键 ids</h1>
|
||||
* */
|
||||
@ApiModel(description = "通用 id 对象")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class TableId {
|
||||
|
||||
@ApiModelProperty(value = "数据表记录主键")
|
||||
private List<Id> ids;
|
||||
|
||||
@ApiModel(description = "数据表记录主键对象")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public static class Id {
|
||||
|
||||
@ApiModelProperty(value = "数据表记录主键")
|
||||
private Long id;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,23 @@
|
||||
package org.example.goods;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
/**
|
||||
* <h1>扣减商品库存</h1>
|
||||
* */
|
||||
@ApiModel(description = "扣减商品库存对象")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class DeductGoodsInventory {
|
||||
|
||||
@ApiModelProperty(value = "商品主键 id")
|
||||
private Long goodsId;
|
||||
|
||||
@ApiModelProperty(value = "扣减个数")
|
||||
private Integer count;
|
||||
}
|
||||
@ -0,0 +1,80 @@
|
||||
package org.example.goods;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* <h1>商品信息</h1>
|
||||
* */
|
||||
@ApiModel(description = "详细的商品信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class GoodsInfo {
|
||||
|
||||
@ApiModelProperty(value = "商品表主键 id")
|
||||
private Long id;
|
||||
|
||||
@ApiModelProperty(value = "商品类别编码")
|
||||
private String goodsCategory;
|
||||
|
||||
@ApiModelProperty(value = "品牌分类编码")
|
||||
private String brandCategory;
|
||||
|
||||
@ApiModelProperty(value = "商品名称")
|
||||
private String goodsName;
|
||||
|
||||
@ApiModelProperty(value = "商品图片")
|
||||
private String goodsPic;
|
||||
|
||||
@ApiModelProperty(value = "商品描述信息")
|
||||
private String goodsDescription;
|
||||
|
||||
@ApiModelProperty(value = "商品状态")
|
||||
private Integer goodsStatus;
|
||||
|
||||
@ApiModelProperty(value = "商品价格, 单位: 分")
|
||||
private Integer price;
|
||||
|
||||
@ApiModelProperty(value = "商品属性")
|
||||
private GoodsProperty goodsProperty;
|
||||
|
||||
@ApiModelProperty(value = "供应量")
|
||||
private Long supply;
|
||||
|
||||
@ApiModelProperty(value = "库存")
|
||||
private Long inventory;
|
||||
|
||||
@ApiModelProperty(value = "创建时间")
|
||||
private Date createTime;
|
||||
|
||||
@ApiModelProperty(value = "更新时间")
|
||||
private Date updateTime;
|
||||
|
||||
/**
|
||||
* <h2>商品属性</h2>
|
||||
* */
|
||||
@ApiModel(description = "商品属性对象")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public static class GoodsProperty {
|
||||
|
||||
@ApiModelProperty(value = "尺寸")
|
||||
private String size;
|
||||
|
||||
@ApiModelProperty(value = "颜色")
|
||||
private String color;
|
||||
|
||||
@ApiModelProperty(value = "材质")
|
||||
private String material;
|
||||
|
||||
@ApiModelProperty(value = "图案")
|
||||
private String pattern;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,33 @@
|
||||
package org.example.goods;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
/**
|
||||
* <h1>简单的商品信息: 封面</h1>
|
||||
* */
|
||||
@ApiModel(description = "简单的商品信息")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class SimpleGoodsInfo {
|
||||
|
||||
@ApiModelProperty(value = "商品表主键 id")
|
||||
private Long id;
|
||||
|
||||
@ApiModelProperty(value = "商品名称")
|
||||
private String goodsName;
|
||||
|
||||
@ApiModelProperty(value = "商品图片")
|
||||
private String goodsPic;
|
||||
|
||||
@ApiModelProperty(value = "商品价格, 单位: 分")
|
||||
private Integer price;
|
||||
|
||||
public SimpleGoodsInfo(Long id) {
|
||||
this.id = id;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
package org.example;
|
||||
Loading…
Reference in New Issue