Java开发学习提高效率的辅助软件和插件:一键生成接口文档,AI制作原型等

0 阅读5分钟

介绍

  • Doucument Assisant:一键生成接口文档,辅助前后端联调的插件
  • RestfulTookit-fix:快速查找API的插件
  • 通义灵码:开发过程中的代码辅助的插件
  • Calicat平台:AI制作原型,支持图片上传后生成原型图片,可以自由调整
  • Mermaid语法:代码实现流程图、序列图、甘特图等,省去制图流程
  • Processon平台:Web制图平台,制作功能模块图,E-R图等
  • Snipaste软件:截图工具,可以实现贴图,取色,复制粘贴保存等
  • Typora软件Markdown文档编辑器,实时编辑预览,可以记录日常学习笔记

IDEA常用快捷键

  • 双击shift调出全局搜索框
  • ctrl+n:按类名搜索
  • ctrl+alt+左键/右键:返回上传浏览的位置
  • ctrl+alt+m:抽取方法
  • ctrl+alt+b:跳转到接口实现类(service层使用impl抽取出接口,在controller使用时,使用ctrl+鼠标点击只能跳转到接口,不能跳转到接口实现类
  • ctrl+alt+o:移除没有调用的包
  • ctrl+y:第一次使用会有提示选择redo或者delete line,选择delete line后续会当成:删除当前行使用
  • ctrl+/:单行注释,已注释的会取消注释,没有注释的会添加注释
  • ctrl+shift+/:多行注释,已注释的会取消注释,没有注释的会添加注释
  • ctrl+alt+L:格式化代码(L是大写)
  • 调用方法比如redisTemplate.opsForHash().get("redis", "username")+.var回车会自动补充定义的变量名

Document Assisant

快速生成接口文档(Markdown语法),可以在idea的插件市场找到

image.png


使用示例: 更详细的使用方法可以查看idea中的插件介绍

  • 在controller层方法上添加文档注释

image.png


  • 入参和回参的实体所有字段均添加文档注释

image.png


  • 右键方法名点击generate会看到REST API或者使用快捷键alt+insert

image.png

RestfulToolkit-fix

用于快速查找API,后端开发中需要根据前端控制台请求的url去找到对应的接口,一个一个控制器找很麻烦,项目庞大还不一定找得到,使用这个插件可以直接复制url进行查找

image.png


使用示例: 快捷键ctrl+\或者ctrl+alt+n,可能会出现快捷键冲突,可以进入: file->setting->Keymap,找到pluging中对应插件的名字进行更改

image.png


使用快捷键调出搜索框后,输入url,选择对应的API进行跳转

image.png

通义灵码

开发过程中辅助编写,使用过一段时间,目前版本对于整个项目读取和分析会比以前更好,对于代码运行过程中的异常能结合上下文进行分析,需要到浏览器官网进行注册后获取API Key,可以根据提示进行配置,很简单

image.png


Calicat平台

使用AI生成原型设计,也可以自由调整原型,对于后端开发者不擅长原型制作比较友好,支持上传图片进行设计,实测效果还行
网站:Calicat平台链接

image.png

Mermaid语法

常规制作流程图需要一个一个形状去设计,并制作图形,使用mermaid语法可以实现代码直接设计图形,节省制图流程。常见软件Typora等也支持mernmaid语法解析
使用教程:Mermaid 使用教程:从入门到精通
示例: 代码:

sequenceDiagram
    # 定义参与者
    participant 用户
    participant 前端
    participant 后端

    # 核心交互流程
    用户->>前端: 输入账号密码,点击登录
    前端->>后端: 发送登录请求
    后端-->>前端: 返回登录成功
    前端-->>用户: 显示登录成功
sequenceDiagram
    # 定义参与者
    participant 用户
    participant 前端
    participant 后端

    # 核心交互流程
    用户->>前端: 输入账号密码,点击登录
    前端->>后端: 发送登录请求
    后端-->>前端: 返回登录成功
    前端-->>用户: 显示登录成功

Processon平台

在线制图Web平台,可用于制作功能模块图,E-R图,流程图等,配备社区和AI,可以在社区查找模板进行更改,免费的导出会有官方水印,一般学习过程中使用挺不错的
网站:processon网站

image.png

Snipaste

开箱即用的截图软件,截图后可以将图片固定在屏幕上,同时还可以使用取色器对屏幕上的颜色进行取色,对前端开发过程中CSS样式设计很有帮助
官网链接:官网链接
快捷键:

  • F1:截图
  • F3:固定在屏幕上
  • ESC:取消固定
  • 更多功能可以查看软件使用介绍,任务栏中右键软件图标点击首选项查看

image.png

Typora

Markdown文档编辑器,可以用于记录日常学习笔记,需要学习Markdown语法,很简单,软件配备语法介绍,15分钟可以基本掌握语法,像博客网站上的文章基本上都是使用Markdown语法编写的,简单易用,适合学习和开发的时候使用
官网链接:国内网站
官网一般在国内无法访问,或者需要转很久,可以上网搜索怎么下载

image.png


除了上面的软件和插件,像博客网站也是提高学习效率的一种工具,可以在上面发表文章,记录自己对于软件、工具的使用,Java中间件源码的理解,既可以帮助别人,也可以帮助自己将来对这些工具使用的一个重温;还有B站,资源最为丰富,对于计算机学习而言在上面可以找到非常多的学习资源。如果有更好的软件和插件,欢迎在评论区补充