`

URI设计原则和规范(转)

阅读更多

什么是URI(URL)

定义

URI: Uniform Resource Locators

URL:Uniform Resource Identicators

URI 分两部分,scheme, scheme-specific ,这两部分由冒号分割开。schema 包括HTTP,FTP,NEWS,GOPHER 等,详情参见RFC1738ftp://ds.internic.net/rfc/rfc1738.txt

语法

HTTP,FTP 的语法很相像,都是这样:

schema://user:password@host:port/directory/file.extension

编码

URI 中理论上只允许ASCII 字符。

部分特殊符号必须编码,不能直接出现在URI 中,如“~”

 

Web 项目中,这些都是URI

链接地址(a 标签的href 属性)

图片的源(img 标签的src 属性)

多媒体文件的源(object 标签的src 属性)

CSSJavaScript 地址(link 标签的href 属性,script 标签的src 属性)

为什么要设计好的URI

重要的入口

便于传播

便于用户挖掘内容

URI 的常见问题

难以输入

URI 不必要的冗长

比如:

http://www.bigcompany.com/PR/announcements/1994/dec/new-server-version.txt

这个还算好的,看看这个:http://www.globeandmail.com/servlet/ArticleNews/PEstory/TGAM/20020909/RVCRR/Business/business/business_temp/2/2/5/

莫明其妙的大写字母

比如:

ftp://ftp.bigstate.edu/pub/docs/OnTBGHill.txt

不常见的标点符号

ftp://ftp.bigstate.edu/pub/docs/moon_3+manual

在纸介质上显示很困难

一些字符在纸上打印出来不容易辨认,例如

“~”(数字键1 旁边那个键)在不同的字体下面显示不同,有时候在一行的顶部,有时候在底部。

l” (字母L 的小写版本)和“1” (数字一)几乎无法分辨——在纸介质上的时候,同样的还有“O” 和“0”

`” 太微小,以致于人们在某些情况下看不到它。

主机和端口的问题

除了 scheme-specific 部分,domainport 也可能给用户带来困惑。

http://admin.bigstate.edu:8001/docs/thesis/jones

设计URI 应该遵循的原则

URI 是网站UI 的一部分,因此,可用的网站应该满足这些URL 要求

 

  • 简单,好记的域名

  • 简短(short )的URI

  • 容易录入的URI

  • URI 能反应站点的结构

  • URI 是可以被用户猜测和hack 的(也鼓励用户如此)

  • 永久链接,Cool URI don't change

聪明的选择URI

一定要短

为了URI 能被方便的录入,写下,拼写和记忆,URI 要尽可能的短,根据w3c 提供的参考数据,一个URI 的长度最好不要超过80 个字节(这并非一个技术限制,经验和统计提供的数据),包括schemahost,port 等。

大小写策略

URI 的大小写策略要适当,要么全部小写,要么首字母大写,应避免混乱的大小写组合,在Unix 世界,文件路径队大小写是敏感的,而在Windows 世界,则不对大小写敏感,所以,http://www.example.com/FOOhttp://www.example.com/foo 是两个不同的URI (尽管他们在Windows 平台有相同的含义)

允许URI 管理

URI 映射

管理员可以重新组织服务器上的文件系统结构,而无需改动URI ,这就需要URI 和真实的服务器文件系统结构之间有一个映射机制,而不是生硬的对应。

这种映射机制可以通过如下技术手段实现:

Aliases ,别名,Apache 上的目录别名,IIS 上的虚拟目录

Symbolic links ,符号链接,Unix 世界的符号链接

Table or database of mappings ,数据库映射,URI 和文件系统结构的对应关系存储在数据库中

标准的重定向

管理员可以简单的通过修改HTTP 状态代码来实现服务器文件系统结构变更之后的URI 兼容,可以利用的HTTP Status Code 有:

301 Moved Permanently ([RFC2616] section 10.3.2)

302 Found (undefined redirect scheme, [RFC2616] Section 10.3.3)

Temporary Redirect ([RFC2616] Section 10.3.8)

用独立的URI

技术无关的URI

  • 提供动态内容服务时,应使用技术无关的URI

    URI 不暴露服务器端使用的脚本语言,平台引擎,而这些语言,平台,引擎的变化也不会导致URI 的变更。因此,sevelet,cgi-bin 之类的单词不应该出现在URI 中。

  • 提供静态内容服务时,应当隐去文件的扩展名

    取而代之的技术是content-negotiation, proxy, URI mapping

身份标志和Session 机制

  • 使用标准的身份认证机制,而不是每个用户一个特定的URI

  • 使用标准的Session 机制,而不是把Session ID 放在URI

    使用TomcatPHP3 的站点容易犯这类错误,将Session ID 放在URI 中,实际上,他们应当用HTTP Header 来实现之。

内容变更时使用标准转向

对变更的内容使用标准的重定向

对删除的资源使用HTTP410

提供索引代理

索引策略

Content-Location

Content-MD5

提供适当的缓存信息

缓存相关的HTTP

缓存策略

缓存生成内容

HTTP HEADHTTP GET

总结

本文详细描述了URI 的定义和作用,揭示了目前Web 开发中普遍存在的问题,并给出了URI 设计原则和规范,希望本文的读者能在开发和设计Web 应用程序的时候体会和运用这些知识。

 

  • URIWeb UI 的一部分,应当像对待网站Logo 和公司品牌一样对待它

  • URI 是网站和普通用户之间的唯一接口,应当像对待你的商务电话号码一样对待它

读懂并记住上面两句话,你下次设计URI 的时候就会给它应有的重视了。

 

  • URL 应当是用户友好的

  • URI 应当是可读的

  • URI 应当是可预测的

  • URI 应当是统一的

读懂和记住上面四句话,你就知道应该设计什么样的URI 了。

分享到:
评论

相关推荐

    RESTful-API设计原则与规范

    ### RESTful-API设计原则与规范 #### 一、背景与基础概念 RESTful架构作为一种流行的互联网软件架构,因其结构清晰、符合标准、易于理解和扩展等特点而受到广泛青睐。REST(Representational State Transfer)的...

    前端开源库-uri-templates

    **uri-templates** 是一种在前端开发中广泛使用的工具,特别是在构建RESTful API时,...在实际项目中,合理利用uri-templates库,能够大大提高代码的可读性和效率,同时遵循RESTful设计原则,使得API接口更加清晰易用。

    REST URI(URL是其子类)命名规范.zip_子类构造方法

    例如,一个错误的URI设计可能是`/users/delete/123`,而正确的做法是使用`/users/123`,然后通过HTTP DELETE方法来执行删除操作。 2. **数量词的处理** 数量词(如“all”,“multiple”)不应直接放入URI中。如果...

    Android-通过Restful的uri完成Activity和Fragment的跳转

    Restful URI设计原则强调资源的可识别性和操作的表述性,将这些原则应用到Android应用中可以提高代码的可读性和可维护性。 首先,理解Restful URI的基本概念。Restful(Representational State Transfer)是一种...

    NET设计规范-.NET约定、惯用法与模式.part2

    2.2 框架设计的基本原则 10 2.2.1 场景驱动设计的原则 11 2.2.2 低门槛原则 17 2.2.3 自说明对象模型原则 20 2.2.4 分层架构原则 25 2.3 小结 27 第3章 命名规范 28 3.1 大小写约定 29 3.1.1 ...

    restful 接口开发规范(RESTfulAPIdesignguide)

    1. URI设计:每一个URI代表一种资源,应采用名词并以复数形式命名。使用小写字母,并用连字符'-'来替代下划线'_',比如:***。 2. 使用HTTP方法:通过HTTP动词(GET、POST、PUT、DELETE等)来表达对资源的操作。...

    NET设计规范-.NET约定、惯用法与模式.part1

    书中介绍了在设计框架时的最佳实践,提供了自顶向下的规范,其中所描述的规范普遍适用于规模不同、可重用程度不同的框架和软件。这些规范历经.NET框架三个版本的长期开发,凝聚了数千名开发人员的经验和智慧。微软的...

    RESTful API设计规范

    它并非一项具体的技术标准,而是一系列设计原则和约束条件的集合。RESTful设计的核心理念在于面向资源,通过统一的接口来描述对资源的操作,从而简化开发流程并提高系统的可伸缩性。 #### 二、RESTful设计的基本...

    restful API 介绍与规范

    #### RESTful 的设计原则 RESTful 提出了以下设计概念与准则: 1. **资源抽象**:网络上的任何事物均可被抽象为资源。 2. **唯一资源标识**:每个资源都拥有唯一的标识符(URI),且操作不会改变这些标识符。 3. *...

    Django Restful 框架设计规范 - 英文原文

    - **URI设计**:如何定义清晰、简洁且具有意义的资源标识符。 - **HTTP方法使用**:合理利用HTTP的标准方法(如GET用于检索资源,POST用于创建资源等)。 - **状态码使用**:使用正确的HTTP状态码来表示操作结果或...

    devops落地思考以及规范参考

    在"devops落地思考以及规范参考"的主题中,我们将深入探讨一系列关键的规范和实践,以帮助DevOps在实际工作环境中有效实施。 1. GitLab分支管理规范:GitLab是广泛使用的版本控制系统,其分支管理是DevOps流程中的...

    服务接口设计文档规范示列

    - 开发者文档:包含项目特定的技术规范和约定。 2 接口列表 本部分列出了服务接口的主要功能,包括货品管理的相关操作。 2.1 货品列表 该接口用于获取货品的列表信息,可能包括货品ID、名称、价格等。请求可能...

    对接规范-20220610.docx

    【接口规范】对接文档主要介绍了如何设计和实施符合RESTful原则的API,以实现高效、易用和可集成的系统接口。RESTful API的核心在于其面向资源的设计,通过HTTP方法来执行CRUD操作,使不同系统间的交互变得更加简单...

    JSF开发规范

    本文档的主要目的是为了规范化JSF(JavaServer Faces)的开发流程,确保开发出的界面能够符合统一的设计标准和技术规范。通过明确界面开发的各个环节及其提交物的要求,本规范有助于实现界面开发的工程化管理,提高...

    uri-template-tester:测试URI是否与给定的URI模板匹配(RFC6570)

    这个工具可以帮助开发者验证自己的URI设计是否符合规范,确保其可扩展性和灵活性。 描述中提到,uri-template-tester是一个URI模板测试器,它允许用户在线测试URI是否与预设的URI模板匹配。这通常对于开发和调试API...

    中国电信SIP规范(共三册)

    此部分主要阐述了SIP在中国电信网络中的应用背景、设计原则以及基本要求。它定义了SIP系统的基本架构,包括用户代理(User Agent)、代理服务器(Proxy Server)、重定向服务器(Redirect Server)、注册服务器...

    接口课程设计1.rar

    理解REST原则,如状态码、URI设计和数据格式(JSON或XML),对于创建高效、可扩展的Web服务至关重要。 5. **代码实现**:课程设计可能涉及实际编码,学生需要使用某种编程语言(如Java、Python、C++等)实现接口。...

Global site tag (gtag.js) - Google Analytics