下载 | 阿里Java开发手册嵩山版

今早阿里云开发社区发布了嵩山版《Java开发手册》

image

那这次新版本的更新有哪些亮点呢?《Java开发手册(嵩山版)》特别增加了前后端交互的一些规约,并修复了一些原来存在的一些问题,接下来让我们先品尝一些嵩山版带来的新的滋味吧。

在前后端工程师分工协作愈加普遍的今天(前后端分离,前端干前端的事情,后端干后端的事情),使效率得到大大的提升,但是凡事有利也有弊,分离的同时也带来了很多协作上的问题。本次开发手册新增的前后端规约旨在解决前后端工程师协作上的问题以及让大家规避工作中常见的、易于疏漏的错误,让大家少走弯路。在现在的前后端协作当中沟通就显得极为重要,但是规范大于约定,正所谓“没有规矩,不成方圆”,大到前后端API的约定,小到前后端的时间格式约定,我们都得精心设计已达到最优的效果。walking本人就亲眼看到过身边的同事因为前后端编码不规范,API不规范,没有沟通到位而大打出手的(脾气都太火爆了😥)。用苹果的宣传语来讲便是“唯一的不同,是处处不同”,所以如果每个系统都对应着自己的一套前后端约定那就非常不利于维护,混乱的约定更让系统接手与维护的人头痛不堪。规矩并非枷锁,而是老司机们上路的安全带,有了它,才能让我们在程序的世界里安全的驰骋,去最大可能的提升效率,去创造更大的奇迹。
前后端交互API的约定
在前后端交互的过程当中,API是重中之重,一个好的API应该能够明确协议、域名、路径、请求方法、请求内容、状态码、响应体等7个重要要素。一个好的API约定会让前后端双方能够为接下来的开发工作节省许多时间和沟通的成本,是我们前后端协作的基石。

整数精度丢失的问题
不同于后端程序的各种数字类型的明确区分,在JS的世界里数字只有一种类型,那就是Number类型,后端的API中往往会返回一些状态字段,结果值是0、1、2这些,如果没有约定好前端就不知道这是数字啊还是字符串,还有,前后端传参时如果没有约定好字段类型也会引发后端的数据类型转换异常。而前端的Number类型它其实是双精度浮点数,因此,它造成的麻烦总是使人困惑和痛苦,当我们将一个过大的整数传递给前端的时候,想象一下当它超过了双精度浮点数能最精确表示范围的时候会出现怎么样的悲剧吧?欲知详情如何,请见嵩山版开发手册吧。

系统错误信息与用户提示信息混淆
你是否曾经把异常带到了页面上?你是否把系统的错误提示发给了一脸懵的用户?walking曾经在和别的系统对接的时候,就看到对方把空指针的堆栈信息都返回给我了😱。今天,前后端规约将助你摆脱这样尴尬的境遇。用户体验不仅仅是产品设计需要考虑的部分,作为技术人的我们更应该注重产品本身的质量,因此用户提示一定要与系统本身的错误区分开,给用户更友好的提示也是系统鲁棒性的象征,另外发生错误的时候返回给前端的信息除了上面两种错误信息再搭配上错误码与HTTP状态码一起食用更香哦。

URL参数传递注意长度
很多场景需要我们用URL来做前后端的参数传递,但是比较蛋疼的是URL有最长长度的限制,而不同的浏览器对URL最大长度限制却是不同的。这些不明确的地方都是不易察觉的深坑,不知道栽进去了多少的仁人志士,为了规避掉入这样的深坑,前后端规约中特别指出,对于URL长度限制采用所有浏览器限制的最小值,为2048字节。

不但有文档,还有集成开发工具插件

Java 规约插件

为了让开发者更加方便、快速的将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse), 该插件在扫描代码后,将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。

Alibaba Cloud Toolkit

从Java代码检查到持续集成、自动化测试、自动部署,全面覆盖研发部署工作场景,支持IntelliJ IDEA、Eclipse、Visual Studio Code等不同IDE,无需对接第三方工具,大幅提升研发效率。 支持一键部署至任意服务器及云端(ECS、EDAS、ACK、ACR、小程序云等),有效降低开发者重复性工作量。

下载学习
公众号后台回复嵩山,获取下载链接

欢迎关注公众号,编程大道,之前整理的 redis 和 MQ 的知识点思维导图分享给大家

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269