[Spring cloud 一步步实现广告系统] 6. Service实现&Zuul配置&Test

  • 时间:
  • 浏览:0
  • 来源:大发时时彩_时时彩最新网址_大发时时彩最新网址
DAO层设计实现

这里其他同学其他同学其他同学其他同学使用Spring DATA JPA来实现数据库操作,当然其他同学其他同学其他同学其他同学也能能使用Mybatis,也有一样的,其他同学其他同学其他同学其他同学依然以用户表操作为例:

/**
 * AdUserRepository for 用户数据库操作接口
 * 继承自JpaRepository<AdUser, Long>,第有一个参数AdUser代表当须要操作的实体类的class定义,第有一个参数Long表示该类的主键类型
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
 */

public interface AdUserRepository extends JpaRepository<AdUser, Long> { 
    /**
     * 根据用户名称获取用户
     *
     * @param username 名称
     * @return 用户对象
     */
    AdUser findByUserName(String username);

    List<AdUser> findAllByUserName(String userName);
}
  • JPARepository 的默认实现法子,有时候其他同学其他同学其他同学其他同学很多继承了JpaRepository而那么实现具体的操作法子,其他同学其他同学其他同学其他同学也是能能通过使用它的默认法子来做CRUD操作的,如下:

功能Service实现

创建service package,依然以用户操作为例,创建com.sxzhongf.ad.service.IUserServicecom.sxzhongf.ad.service.impl.UserServiceImpl,UserServiceImpl实现了IUserService

  1. 创建 IUserService 接口
/**
 * IUserService for 用户service
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
public interface IUserService {
    /**
     * 创建用户接口
     *
     * @param userRequestVO {@link UserRequestVO}
     * @return {@link UserResponseVO}
     * @throws AdException 错误
     */
    UserResponseVO createUser(UserRequestVO userRequestVO) throws AdException;

    List<AdUser> findAllByUserName(String userName);
}
  1. 使用IUserService接口
/**
 * UserServiceImpl for 用户service
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
@Slf4j
@Service
public class UserServiceImpl implements IUserService {

    private final AdUserRepository userRepository;

    @Autowired
    public UserServiceImpl(AdUserRepository userRepository) {
        this.userRepository = userRepository;
    }

    /**
     * 创建用户
     *
     * @param userRequestVO {@link UserRequestVO}
     * @return result {@link UserResponseVO}
     */
    @Override
    @Transactional
    public UserResponseVO createUser(UserRequestVO userRequestVO) throws AdException {
        if (!userRequestVO.validate()) {
            log.error("Request params error: {}", userRequestVO);
            throw new AdException(Constants.ErrorMessage.REQUEST_PARAM_ERROR);
        }
        //查重
        AdUser existUser = userRepository.findByUserName(userRequestVO.getUserName());
        if (existUser != null) {
            log.error("{} user is not exist.", userRequestVO.getUserName());
            throw new AdException(Constants.ErrorMessage.USER_EXIST);
        }
        AdUser user = userRepository.save(new AdUser(userRequestVO.getUserName(), CommonUtils.md5(userRequestVO.getUserName())));
        log.info("current user is : {}", user);
        return new UserResponseVO(user.getUserId(), user.getUserName(), user.getToken(),
                user.getCreateTime(), user.getUpdateTime());
    }

    @Override
    public List<AdUser> findAllByUserName(String userName) {
        return userRepository.findAllByUserName(userName);
    }
}
  1. 创建数据传输对象(dto/vo)

    确实好多人在这里前会 特别懊悔,搞不清楚什么命名有什么区别,所有人建议是其他同学其他同学其他同学其他同学不需要纠结,dto(data transfer object),很多表示其他同学其他同学其他同学其他同学在各个层传递的对象,vo在展示层操作的对象。有时候并也有很多个命名,它的本质很多有一个object, 你传递到DAO层能能吗?当然能能,你传单独字段也有能能的。很多,没必要过分纠结并也有信息,咬文嚼字有本来反而会适得其反。

/**
 * UserRequestVO for 创建用户请求对象VO
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserRequestVO {
    private String userName;
    public boolean validate() {
        return !StringUtils.isEmpty(userName);
    }
}

---
  
/**
 * UserResponseVO for 用户响应VO
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserResponseVO {
    private Long userId;
    private String userName;
    private String token;
    private Date createTime;
    private Date updateTime;
}
  1. 有时候报错信息有有时候是相同的,另有一个们抽取有一个常量类来封装。
/**
 * Constants for TODO
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
public class Constants {
    /**
     * 通用错误信息异常类
     */
    public static class ErrorMessage {
        public static final String REQUEST_PARAM_ERROR = "请求参数异常";
        public static final String USER_EXIST = "用户已发生";
        public static final String USER_NOT_EXIST = "用户不发生";
    }
}
  1. 在Common Project 下面创建有一个工具类com.sxzhongf.ad.common.utils.CommonUtils,用来对用户username进行md5加密来获取token信息。
/**
 * CommonUtils for 工具类
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
@Slf4j
public class CommonUtils {
    /**
     * md5 加密
     */
    public static String md5(String value) {
        return DigestUtils.md5Hex(value).toUpperCase();
    }
}

参考创建用户的实现,依次实现某些表操作。

Controller实现

依然以用户功能实现为例:

/**
 * UserController for 用户controller
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 */
@RestController
@Slf4j
@RequestMapping("/user")
public class UserController {
    @Autowired
    private IUserService userService;

    @PostMapping(path = "/create")
    public UserResponseVO createUser(@RequestBody UserRequestVO requestVO) throws AdException {
        log.info("ad-sponsor: createUser -> {}", JSON.toJSONString(requestVO));
        return userService.createUser(requestVO);
    }

    @GetMapping(path = "/get")
    public CommonResponse getUserList(@Param(value = "username") String username) throws AdException {
        log.info("ad-sponsor: getUserList -> {}", JSON.toJSONString(username));
        return new CommonResponse(userService.findAllByUserName(username));
    }
}
在网关中配置广告投放系统

其他同学其他同学其他同学其他同学在投放系统的配置中,配置了server.servlet.context-path:/ad-sponsor那么有一个路径,是因为着所有请求当前系统的路径都须要带有ad-sponsor, 例如于:http://xxx/ad-sponsor/user/get?username=yyy,这是网关请求所必需的。根据上述,其他同学其他同学其他同学其他同学在网关服务中配置其他同学其他同学其他同学其他同学当前的投放系统:

spring:
  application:
    name: ad-gateway-zuul
server:
  port: 1111
eureka:
  client:
    service-url:
      defaultZone: http://server1:7777/eureka/,http://server2:8888/eureka/,http://server3:9999/eureka/
  instance:
    hostname: ad-gateway-zuul
##############################################
# 以下为重要信息
zuul:
  ignored-services: '*' # 过滤所有请求,除了下面routes中声明过的服务
  # 配置网关路由规则
  routes:
    sponsor: #在路由中自定义服务路由名称
      path: /ad-sponsor/**
      serviceId: mscx-ad-sponsor #微服务name
      strip-prefix: false
    search: #在路由中自定义服务路由名称
      path: /ad-search/**
      serviceId: mscx-ad-search #微服务name
      strip-prefix: false
  prefix: /gateway/api
  strip-prefix: false #不对 prefix: /gateway/api 设置的路径进行截取,默认转发会截取掉配置的前缀
Test
  • 直接访问投放系统

    调用curl -G http://localhost:7000/ad-sponsor/user/get?username=Isaac%20Zhang,返回结果:

{
  code: 0,  // 统一成功标示
  message: "success", // 统一处里结果message
  data: [  // 具体的对象信息
    {
      userId: 10,
      userName: "Isaac Zhang",
      token: "2D3ABB6F2434109A105170FB21D00453",
      userStatus: 1,
      createTime: 156111887100,
      updateTime: 156111887100
    }
  ]
}
  • 通过网关调用

    有时候我在网关配置中加了前缀prefix: /gateway/api,有时候,其他同学其他同学其他同学其他同学访问的本来须要添换成并也有前缀信息,有时候会报404错误。

    curl -G http://localhost:1111/gateway/api/ad-sponsor/user/get?username=Isaac%20Zhang,其他同学其他同学其他同学其他同学发现结果并那么按照其他同学其他同学其他同学其他同学想象的展示出来。

    bogon:~ zhangpan$ http://localhost:1111/gateway/api/ad-sponsor/user/get?username=Isaac%20Zhang
    -bash: http://localhost:1111/gateway/api/ad-sponsor/user/get?username=Isaac%20Zhang: No such file or directory

    为什么在么在会 会 呢?其他同学其他同学其他同学其他同学来查看一下日志:

    2019-07-27 20:44:19.093  INFO 4766 --- [nio-1111-exec-4] c.s.a.g.filter.ValidateTokenFilter       : GET request to http://localhost:1111/gateway/api/ad-sponsor/user/get
    2019-07-27 20:44:19.093  WARN 4766 --- [nio-1111-exec-4] c.s.a.g.filter.ValidateTokenFilter       : access token is empty
    2019-07-27 20:44:19.098  INFO 4766 --- [nio-1111-exec-4] c.s.ad.gateway.filter.AccessLogFilter    : Request "/gateway/api/ad-sponsor/user/get" spent : 0 seconds.
    2019-07-27 20:48:37.1001  INFO 4766 --- [trap-executor-0] c.n.d.s.r.aws.ConfigClusterResolver      : Resolving eureka endpoints via configuration

    其他同学其他同学其他同学其他同学能能清晰的就看,ValidateTokenFilter : access token is empty,为什么在么在会 会 会有那么有一个报错呢?那是有时候我在配置网关的本来,换成了一次拦截:

    /**
     * ValidateTokenFilter for 服务token校验
     *
     * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
     */
    @Slf4j
    @Component
    public class ValidateTokenFilter extends ZuulFilter {
    ...
        @Override
        public Object run() throws ZuulException {
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
    
            Object accessToken = request.getHeader("accessToken"); //.getParameter("accessToken");
            if (accessToken == null) {
                log.warn("access token is empty");
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(401);
    //            ctx.setResponseBody(body)对返回body内容进行编辑
                return null;
            }
            log.info("access token ok");
            return null;
        }
    }

    观察代码其他同学其他同学其他同学其他同学发现,会从RequestHeader中获取accessToken参数,其他同学其他同学其他同学其他同学那么提供,当然就会报错了呀。接下来,其他同学其他同学其他同学其他同学提供上该参数再试:

    bogon:~ zhangpan$ curl -H "accessToken:true" http://localhost:1111/gateway/api/ad-sponsor/user/get?username=Isaac%20Zhang
    ---返回
    {"code":0,"message":"success","data":[{"userId":10,"userName":"Isaac Zhang","token":"2D3ABB6F2434109A105170FB21D00453","userStatus":1,"createTime":156111887100,"updateTime":156111887100}]}

    至此,其他同学其他同学其他同学其他同学的广告投放系统简单功能有时候完整版实现完毕,有时候能能通过网关进行转发。