手把手教你云相册项目简易开发day5 API服务搭建和权限框架

本文涉及的产品
云数据库 Tair(兼容Redis),内存型 2GB
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
简介: 手把手教你云相册项目简易开发day5 API服务搭建和权限框架

文章只提供了部分代码,每一天对应着分支工具类等完整代码都可以去github上获取,地址:https://github.com/kkoneone11/cloud-photo/

用户登录服务功能

流程图

数据库

开发过程

1.基础配置

1.1在application配置类里改一下名字,端口9008

1.2创建启动类,启动类头上配置

@EnableDiscoveryClient
@SpringBootApplication
@MapperScan(basePackages = {"com.cloud.photo.users.mapper"})

1.3pom文件导入

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>cloud-photo-common</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

1.4通过代码生成器操作user表生成代码

2.接口开发

2.1接口1:根据手机号获取用户信息/user/getUserInfo Get

2.1.1参数分析:根据手机phone可以唯一确定一个用户

2.1.2通过phone查询用户信息

/**
     * 获得用户信息,根据用户手机获取用户信息
     * @param phone
     * @return resultBody
     */
    @GetMapping("/getUserInfo")
    public ResultBody getUserInfo(@RequestParam(value = "phone") String phone){
        log.info("getUserInfo-phone"+ phone + ",start!");
        User user = userService.getOne(new QueryWrapper<User>().eq("phone",phone));
        log.info("getUserInfo()-phone=" + phone + ",user=" + user);
        ResultBody resultBody = (user == null ) ? ResultBody.error(CommonEnum.USER_IS_NULL) : ResultBody.success(user);
        log.info("getUserInfo()-phone=" + phone + ",resultBody=" + resultBody);
        return resultBody;
    }
2.2接口2:用户执行登录/user/login POST

2.2.1参数分析:phone,通过phone参数查询用户

2.2.2通过phone查询是否存在用户,如果

  • 不存在则创建一个新用户并设置相关参数
  • 存在则更新登录时间然后更新登录的次数

最后将用户更新

注意修改user实体里的LocalDateTime为Date否则会报错

/**
     * 登录
     * @param userBo
     * @return
     */
    @PostMapping("/login")
    public ResultBody login(@RequestBody UserBo userBo){
        String phone = userBo.getPhone();
        //查询用户
        User user = userService.getOne(new QueryWrapper<User>().eq("phone", phone), false);
        //1.用户不存在则生成
        if(user == null){
            //组装
            user = new User();
            //复制
            BeanUtils.copyProperties(userBo, user);
            //自定义一个用户ID
            user.setUserId(RandomUtil.randomString(9));
            user.setCreateTime(DateUtil.date());
            user.setUpdateTime(DateUtil.date());
            user.setLoginCount(0);
            //普通用户
            user.setRole("user");
        }else{
        //2.存在则更新状态即可
            user.setUpdateTime(DateUtil.date());
            user.setLoginCount(user.getLoginCount()+1);
        }
        //入库
        boolean saveOrUpdate = userService.saveOrUpdate(user);
        return saveOrUpdate ? ResultBody.success() : ResultBody.error(CommonEnum.LOGIN_FAIL);
    }
2.3接口3:根据手机号检查用户是否存在/user/checkPhone Get

2.3.1参数分析:phone

2.3.2

/**
     * 查询用户是否存在
     *
     * @param phone 手机号
     * @return 查询结果
     */
    @GetMapping("/checkPhone")
    public ResultBody checkPhone(@RequestParam(value = "phone") String phone) {
        User userEntity = userService.getOne(new QueryWrapper<User>().eq("phone", phone));
        return userEntity == null ? ResultBody.error(CommonEnum.USER_IS_NULL) : ResultBody.success();
    }
2.4接口4:管理员检查账号密码/user/checkAdmin Get

2.4.1参数分析:phone,password。因为是管理员的话需要账号密码去验证

2.4.2拿到phone和password之后去执行一条查询语句看是否存在该用户

/**
     * 检查管理员登录
     * @param userName
     * @param password
     * @return
     */
    @GetMapping("/checkAdmin")
    public ResultBody checkAdmin(@RequestParam(value = "userName")String userName,
                                 @RequestParam(value = "password"),String password){
        User user = userService.getOne(new QueryWrapper<User>()
                .eq("user_name", userName)
                .eq("password", password)
                .eq("role", CommonConstant.ADMIN));
        return user == null ? ResultBody.error(CommonEnum.USERNAME_PASSWORD_ERROR) : ResultBody.success();
    }

API接口开发

在api项目中实现

用户登录后前端会给后端一个satoken的认证凭证,

开发过程

1.基础配置

1.1因为需要用到saToken进行鉴权所以先在pom文件导入

<dependencies>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>cloud-photo-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--        sa-token 权限框架-->
        <dependency>
            <groupId>cn.dev33</groupId>
            <artifactId>sa-token-spring-boot-starter</artifactId>
            <version>1.34.0</version>
        </dependency>
        <!--        sa-token 开启注解-->
        <dependency>
            <groupId>cn.dev33</groupId>
            <artifactId>sa-token-spring-aop</artifactId>
            <version>1.34.0</version>
        </dependency>
        <!--        sa-token 集成redis-->
        <dependency>
            <groupId>cn.dev33</groupId>
            <artifactId>sa-token-dao-redis-jackson</artifactId>
            <version>1.34.0</version>
        </dependency>
    </dependencies>

1.2在config包加入一个GlobalExceptionHandler全局捕获类,在utils包导入一个MyUtil类最后在nacosdiscovery包导入一个NacosDiscoveryConfiguration类

1.3配置一个启动类,注解备注

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients(basePackages = {"com.cloud.photo.common.fegin"})

1.4在Controller包和service包下分别创建以下

2.接口开发

2.1接口1:/api/login POST

2.1.1先在LoginController创建一个login()放,然后具体业务在service中实现。

先通过StpUtil工具类的isLogin()通过判断token是否存在且对得上,如果是则直接放行。否则则要看userBo是否为空,为空这返回登录信息为空的错误。然后判断是否是

  • 管理员登录,检查是否有账号密码,检查账号密码是否正确,正确则调用doLogin方法放行
  • 普通用户登录则检查调用checkPhone()看用户是否存在即可,不存在则表明第一次登录需要填入相关信息,检查是否有填入相关信息。补全了则直接doLogin()放行。
2.2接口2:/api/logout POST

2.2.1:先用StpUtil的isLogin()判断是否已经登录,已经登录了的话再继续找到该账户对应的loginId然后找到session,清空里面的session之后再执行StpUtil的logout()方法

/**
     * 退出
     * @return
     */
    @Override
    public ResultBody logout() {
       if(StpUtil.isLogin()){
           String loginId = StpUtil.getLoginIdAsString();
           SaSession session = StpUtil.getSessionByLoginId(loginId);
           //清空session
           session.logout();
           StpUtil.logout();
       }
       return ResultBody.success();
    }
2.3接口3:/api/getUserInfo POST

2.3.1先看用户是否有登录,没有登录直接返回错误消息,如果已经登录了则先看session里是否有消息,

  • session有消息先拿出loginId然后再拿到session,session不为空则继续拿到里面的userInfo,userInfo不为空就返回信息。
  • session没有消息则调用users的getUserInfo()方法,然后再将userInfo存入到session里,最后再返回userInfo
2.4接口4:doLogin()

2.4.1参数分析:userBo,phone

2.4.2传入userBo调用users子项目的login方法检验参数是否成功,如果成功则再传入phone执行StpUtil的login()方法登录并产生token,把token返回给前端

2.5接口5:/api/getTransList POST

2.5.1在TransController下写一个getTransList()方法,先通过MyUtils的getUserInfo()拿到用户信息

然后拿到userId,再组装一个匹配前缀给stringRedisTemplate的keys方法拿到所有keys,如果keys不为空则通过stream流遍历所有key拿出里面的value然后再组装回去。最后通过sorted方法按上传时间降序排序即可。

/**
 * 传输管理相关接口
 * @author kkoneone11
 */
@RestController
@RequestMapping("/api")
public class TransController {
    @Resource
    private StringRedisTemplate stringRedisTemplate;
    @PostMapping("/getTransList")
    public ResultBody getTransList(){
        UserBo userInfo = MyUtils.getUserInfo();
        //用户信息为空则返回错误
        if(userInfo == null){
            return ResultBody.error(CommonEnum.USER_IS_NULL);
        }
        //不为空则拿到userId
        String userId = userInfo.getUserId();
        //组装匹配前缀
        String keyPatten = userId + ":" + "*";
        //拿出keys
        Set<String> keys = stringRedisTemplate.keys(keyPatten);
        //keys不为空则遍历
        if(keys!=null && CollUtil.isNotEmpty(keys)){
            List<FileUploadBo> uploadBos = keys.stream().map(key -> {
                String value = stringRedisTemplate.opsForValue().get(key);
                return JSONUtil.toBean(value,FileUploadBo.class);
            }).collect(Collectors.toList());
            //按上传时间降序
            uploadBos = uploadBos.stream().sorted(Comparator.comparing(FileUploadBo::getUploadTime, Comparator.reverseOrder())).collect(Collectors.toList());
            return ResultBody.success(uploadBos);
        }else{
            return ResultBody.error(CommonEnum.TRANS_IS_NULL);
        }
    }
}
2.6接口6:/api/getAlbumCategorize Get

2.6.1在AlbumController写一个getAlbumCategorize()方法。同样先分局MyUtils的getUserInfo()

从缓存中拿到用户信息,用户信息为空则返回错误。不为空则拿出userId然后构造一个albumPageBo设置相关信息,然后分别设置人物、地点、事物的分类信息然后分别最后getUserAlbumList()方法传入albumPageBo查询并放入jsonObject中最后返回即可

2.6.2在service方法里写一个getUserAlbumList方法调用userFilelist

@Override
    public ResultBody getUserAlbumList(AlbumPageBo pageBo) {
        return cloud2TransService.userFilelist(pageBo);
    }
/**
     * 获取用户照片分类信息
     * @return 带有用户地点、人物、事物 三种标签的缩略图 (三张 按照上传时间排序)
     */
//    @SaCheckLogin
    @GetMapping("/getAlbumCategorize")
    public ResultBody getAlbumCategorize(){
        //缓存中拿到用户信息
        UserBo userInfo = MyUtils.getUserInfo();
        if(userInfo == null){
            return ResultBody.error(CommonEnum.USER_IS_NULL);
        }
        String userId = userInfo.getUserId();
        //组装AlbumPageBo
        AlbumPageBo albumPageBo = new AlbumPageBo();
        albumPageBo.setUserId(userId);
        albumPageBo.setCurrent(1);
        albumPageBo.setPageSize(3);
        //再组装一个jsonObject最后面返回
        JSONObject jsonObject = new JSONObject();
        //人物
        albumPageBo.setCategory(CommonConstant.IMAGE_CATEGORY_1);
        jsonObject.put("person",albumService.getUserAlbumList(albumPageBo));
        //地点
        albumPageBo.setCategory(CommonConstant.IMAGE_CATEGORY_2);
        jsonObject.put("location",albumService.getUserAlbumList(albumPageBo));
        //事物
        albumPageBo.setCategory(CommonConstant.IMAGE_CATEGORY_3);
        jsonObject.put("thing",albumService.getUserAlbumList(albumPageBo));
        return ResultBody.success(jsonObject);
    }
2.7接口7:/api/getUserAlbumList POST

2.7.1参数分析 AlbumPageBo

2.7.2从缓存中拿到用户信息,用户信息为空则返回错误。不为空则拿出userId然后将albumPageBo设置一个userId最后getUserAlbumList()方法传入albumPageBo

/**
     * 获取用户所有上传的图片(分页)
     * @return 返回带有文件信息的实体列表(包括大小图、上传时间等)
     */
//    @SaCheckLogin
    @PostMapping("/getUserAlbumList")
    public ResultBody getUserAlbumAll(@RequestBody AlbumPageBo pageBo){
        //从缓存拿到用户信息
        UserBo userInfo = MyUtils.getUserInfo();
        if (userInfo == null){
            return ResultBody.error(CommonEnum.USER_IS_NULL);
        }
        //用户ID
        String userId = userInfo.getUserId();
        pageBo.setUserId(userId);
        // 业务实现
        return albumService.getUserAlbumList(pageBo);
    }
2.8接口8:/api/getUserAlbumDetail POST

2.8.1从缓存中拿到用户信息,用户信息为空则返回错误。不为空则拿出userId然后将analyzeBo

设置一个userId然后在albumService里实现getUserAlbumDetail()的逻辑,直接调用cloud2ImageService的getMediaInfo()方法即可。

2.9接口9:/api/previewImage Get

2.9.1参数分析:fileId, iconCode这两样可以唯一确定想要的缩略图

2.9.2先组装一个fileResizeIconBo,往里塞入fileId, iconCode两个参数,然后调用albumService的previewImage()方法,里面的业务逻辑是调用cloud2ImageService的getIconUrl()方法获得缩略图的下载地址,然后判断下载地址是否为空,不为空则转发这个url,否则返回null即可。

/**
     * 获取用户单个图片格式分析信息
     * @return 返回带有文件信息的实体列表(包括大小图、上传时间等)
     */
//    @SaCheckLogin
    @GetMapping("/previewImage")
    public ResultBody previewImage(@RequestParam String fileId, @RequestParam String iconCode, HttpServletResponse response){
        FileResizeIconBo fileResizeIconBo =new FileResizeIconBo();
        fileResizeIconBo.setFileId(fileId);
        fileResizeIconBo.setIconCode(iconCode);
        // 业务实现
        ResultBody resultBody = albumService.previewImage(fileResizeIconBo);
        String iconUrl = null;
        if(resultBody.getData()!=null && StringUtils.isNotBlank(resultBody.getData().toString())){
            iconUrl = resultBody.getData().toString();
            response.setStatus(302);
            try {
                response.sendRedirect(iconUrl);
            } catch (IOException e) {
                log.error("response.sendRedirect error!" , e);
            }
        }
        return null;
    }
2.10接口10:/api/getPutUploadUrl POST

2.10.1参数分析:fileUploadBo,因为需要获得上传地址,所以bo里还有FileName、FileMd5、FileSize

2.10.2从缓存中拿到用户信息,用户信息为空则返回错误。不为空则拿出userId然后fileUploadBo

设置一个userId,最后在service写一个getPutUploadUrl()方法,调用cloud2TransService

的getPutUploadUrl()方法并传入FileId、FileName、FileMd5、FileSize参数,看返回值里的是否成功,成功则看返回的数据里有没有storageObjectId,有则是秒传,往fileUploadBo里塞入即可。否则往fileUploadBo里塞入containerId、objectId、url、base64Md5

@Override
    public ResultBody getPutUploadUrl(FileUploadBo fileUploadBo) {
        ResultBody resultBody = cloud2TransService.getPutUploadUrl(fileUploadBo.getUserId(),
                fileUploadBo.getFileName(),
                fileUploadBo.getFileMd5(),
                fileUploadBo.getFileSize());
        //存进缓存的Key
        String key = fileUploadBo.getUserId() + ":" +  fileUploadBo.getFileMd5();
        if (resultBody.getCode().equals(CommonEnum.SUCCESS.getResultCode())) {
            //成功
            JSONObject obj = JSONUtil.parseObj(resultBody.getData());
            if (obj.containsKey("storageObjectId")) {
                //是秒传
                fileUploadBo.setStorageObjectId(obj.getStr("storageObjectId"));
            } else {
                //不是秒传
                fileUploadBo.setContainerId(obj.getStr("containerId"));
                fileUploadBo.setObjectId(obj.getStr("objectId"));
                fileUploadBo.setUploadUrl(obj.getStr("url"));
                fileUploadBo.setBase64Md5(obj.getStr("base64Md5"));
            }
            //成功了状态是传输中
            fileUploadBo.setStatus(CommonConstant.FILE_UPLOAD_ING);
            fileUploadBo.setUploadTime(DateUtil.now());
            stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(fileUploadBo), 1, TimeUnit.DAYS);
        }else {
            //失败了状态是传输失败
            fileUploadBo.setStatus(CommonConstant.FILE_UPLOAD_FAIL);
            fileUploadBo.setUploadTime(DateUtil.now());
            stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(fileUploadBo), 1, TimeUnit.DAYS);
        }
        return ResultBody.success(fileUploadBo);
    }
2.11接口11:/api/commitUpload  POST
@Override
    public ResultBody commitUpload(FileUploadBo bo) {
        //存进缓存的Key
        String key = bo.getUserId() + ":" +  bo.getFileMd5();
        ResultBody commitResultBody = cloud2TransService.commit(bo);
        if (commitResultBody.getCode().equals(CommonEnum.SUCCESS.getResultCode())){
            //成功提交 - 状态更新为传输成功
            bo.setStatus(CommonConstant.FILE_UPLOAD_SUCCESS);
            stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(bo), 1, TimeUnit.DAYS);
        }else {
            //提及失败 - 状态更新为传输失败
            bo.setStatus(CommonConstant.FILE_UPLOAD_FAIL);
            stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(bo), 1, TimeUnit.DAYS);
        }
        return commitResultBody;
    }
相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
相关文章
|
6天前
|
监控 供应链 搜索推荐
阿里妈妈商品详情API接口:开发、应用与收益的深度剖析
阿里妈妈是阿里巴巴旗下的数字营销平台,其商品详情API接口为开发者提供了获取淘宝、天猫等电商平台商品详细信息的工具。本文介绍了该接口的开发流程、应用场景及带来的收益,揭示了其在电商生态中的重要地位。
48 6
|
6天前
|
供应链 搜索推荐 API
1688APP原数据API接口的开发、应用与收益(一篇文章全明白)
1688作为全球知名的B2B电商平台,通过开放的原数据API接口,为开发者提供了丰富的数据资源,涵盖商品信息、交易数据、店铺信息、物流信息和用户信息等。本文将深入探讨1688 APP原数据API接口的开发、应用及其带来的商业收益,包括提升流量、优化库存管理、增强用户体验等方面。
34 6
|
8天前
|
监控 搜索推荐 API
京东商品详情API接口的开发、应用与收益探索
在数字化和互联网高速发展的时代,京东通过开放商品详情API接口,为开发者、企业和商家提供了丰富的数据源和创新空间。本文将探讨该API接口的开发背景、流程、应用场景及带来的多重收益,包括促进生态系统建设、提升数据利用效率和推动数字化转型等。
31 3
|
13天前
|
供应链 搜索推荐 API
探索1688榜单商品详细信息API接口:开发、应用与收益
本文深入探讨了1688榜单商品详细信息API接口的开发与应用,涵盖接口概述、开发条件、调用方法及数据处理等内容。该API帮助企业高效获取1688平台商品信息,应用于商品信息采集、校验、同步与数据分析等领域,有效提升了企业的运营效率、库存管理、销售转化率及市场策略制定能力,降低了采购成本,提升了客户满意度。
37 9
|
16天前
|
算法 Java API
如何使用Java开发获得淘宝商品描述API接口?
本文详细介绍如何使用Java开发调用淘宝商品描述API接口,涵盖从注册淘宝开放平台账号、阅读平台规则、创建应用并申请接口权限,到安装开发工具、配置开发环境、获取访问令牌,以及具体的Java代码实现和注意事项。通过遵循这些步骤,开发者可以高效地获取商品详情、描述及图片等信息,为项目和业务增添价值。
50 10
|
16天前
|
存储 API 数据库
使用Python开发获取商品销量详情API接口
本文介绍了使用Python开发获取商品销量详情的API接口方法,涵盖API接口概述、技术选型(Flask与FastAPI)、环境准备、API接口创建及调用淘宝开放平台API等内容。通过示例代码,详细说明了如何构建和调用API,以及开发过程中需要注意的事项,如数据库连接、API权限、错误处理、安全性和性能优化等。
63 5
|
15天前
|
数据可视化 搜索推荐 API
速卖通获得aliexpress商品详情API接口的开发、应用与收益。
速卖通(AliExpress)作为阿里巴巴旗下的跨境电商平台,为全球消费者提供丰富商品。其开放平台提供的API接口支持开发者获取商品详情等信息,本文探讨了速卖通商品详情API的开发流程、应用场景及潜在收益,包括提高运营效率、降低成本、增加收入和提升竞争力等方面。
34 1
|
2天前
|
存储 搜索推荐 API
小红书笔记详情API接口的开发、应用与收益
小红书笔记详情API接口为开发者、企业和内容创作者提供了获取平台丰富资源的通道。通过该接口,用户可以提取笔记的详细信息(如标题、正文、标签等),并应用于市场调研、竞品分析、内容创作、电商推荐等多个领域。这不仅有助于提升品牌影响力和优化用户体验,还能挖掘商业机会,促进内容创新,增强用户互动与社群凝聚力。总之,小红书笔记详情API接口为企业和个人在社交媒体领域探索新增长点提供了重要工具。
17 0
|
29天前
|
JSON API 数据格式
探索后端开发:从零构建简易RESTful API
在数字时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户界面与数据世界。本文将引导读者步入后端开发的殿堂,通过构建一个简易的RESTful API,揭示其背后的逻辑与魅力。我们将从基础概念出发,逐步深入到实际操作,不仅分享代码示例,更探讨如何思考和解决问题,让每一位读者都能在后端开发的道路上迈出坚实的一步。
|
1月前
|
缓存 前端开发 API
深入浅出:后端开发中的RESTful API设计原则
【10月更文挑战第43天】在数字化浪潮中,后端开发如同搭建梦想的脚手架,而RESTful API则是连接梦想与现实的桥梁。本文将带你领略API设计的哲学之美,探索如何通过简洁明了的设计,提升开发效率与用户体验。从资源定位到接口约束,从状态转换到性能优化,我们将一步步构建高效、易用、可维护的后端服务。无论你是初涉后端的新手,还是寻求进阶的开发者,这篇文章都将为你的开发之路提供指引。让我们一起走进RESTful API的世界,解锁后端开发的新篇章。