Signpost快速上手5分钟：从Maven依赖到签发出第一个OAuth请求

Signpost快速上手5分钟从Maven依赖到签发出第一个OAuth请求【免费下载链接】signpostA light-weight client-side OAuth library for Java项目地址: https://gitcode.com/gh_mirrors/si/signpostSignpost 是一个轻量级的 Java 客户端 OAuth 库遵循 OAuth 1.0a 标准帮助你用极少代码为 HTTP 请求生成 OAuth 签名。本教程带你用 5 分钟完成 Java OAuth 库快速上手从添加 Signpost Maven 依赖到创建 OAuthConsumer最终签发出第一个 OAuth 请求。Signpost 是什么轻量级 Java OAuth 签名库 ⚡Signpost 只做一件事但做得很简单签名 HTTP 请求——自动拼装 OAuth 参数并计算签名HMAC-SHA1 / HMAC-SHA256 / PLAINTEXT申请 Token——配合 OAuthProvider 完成 OAuth 三步握手请求 Token → 用户授权 → 换取 Access Token它设计得不侵入不会包裹或隐藏你的 HTTP 层你只需把请求对象交给它签名底层 HTTP 库的所有能力依然归你掌控。同时它是模块化的核心模块之外还有针对不同 HTTP 库的适配模块模块支持的 HTTP 库源码位置signpost-coreJava 自带HttpURLConnectionsignpost-core/signpost-commonshttp4Apache Commons HTTP 4.xsignpost-commonshttp4/signpost-jetty6Jetty HTTP Client 6.xsignpost-jetty6/第一步5 行代码添加 Maven 依赖 如果你用 Maven 管理项目只需在pom.xml中声明signpost-core依赖即可这是所有场景都需要的核心模块dependencies dependency groupIdoauth.signpost/groupId artifactIdsignpost-core/artifactId version2.1.1/version scopecompile/scope /dependency /dependencies如果你使用的是 Apache Commons HTTP 或 Jetty 客户端再额外引入对应模块例如dependency groupIdoauth.signpost/groupId artifactIdsignpost-commonshttp4/artifactId version2.1.1/version /dependency不想用 Maven也可以克隆源码后用mvn install本地构建构建出的 JAR 会生成在target/目录中。第二步认识两大核心对象 使用 Signpost 前请先向你的 OAuth 服务提供方申请好Consumer Key和Consumer Secret。之后只需两个对象OAuthConsumer——签名者。持有密钥和 Token负责为每个 HTTP 请求生成签名OAuthProvider——换票者。封装服务方的三个端点地址请求 Token、Access Token、授权页面负责完成三步握手对应的默认实现分别位于signpost-core/src/main/java/oauth/signpost/basic/DefaultOAuthConsumer.java和signpost-core/src/main/java/oauth/signpost/basic/DefaultOAuthProvider.java// 消费者负责签名 OAuthConsumer consumer new DefaultOAuthConsumer(CONSUMER_KEY, CONSUMER_SECRET); // 提供者负责换取 Token OAuthProvider provider new DefaultOAuthProvider( REQUEST_TOKEN_ENDPOINT_URL, // 请求 Token 的地址 ACCESS_TOKEN_ENDPOINT_URL, // 换取 Access Token 的地址 AUTHORIZE_WEBSITE_URL); // 用户授权页面地址第三步三步握手签发出第一个 OAuth 请求 ✍️1️⃣ 获取请求 TokenSignpost 会同时拼好需要用户访问的授权 URLString authUrl provider.retrieveRequestToken(consumer, CALLBACK_URL); // 把用户带到 authUrl由用户手动授权如果应用无法接收回调比如桌面应用请将CALLBACK_URL换成OAuth.OUT_OF_BAND即 oob。2️⃣ 换取 Access Token。用户授权成功后用回调中拿到的验证码oauth_verifier或 PIN 码换取正式 Tokenprovider.retrieveAccessToken(consumer, verificationCode);3️⃣ 签名并发送请求。此时 consumer 已持有有效的 Access Token对任何受保护资源发起请求只需一步签名consumer.setTokenWithSecret(ACCESS_TOKEN, TOKEN_SECRET); HttpURLConnection request (HttpURLConnection) new URL(http://example.com/protected).openConnection(); consumer.sign(request); // 一步签名OAuth 参数全部自动注入 request.connect(); // 发送请求看到200 OK你就已经完成从 Maven 依赖到签发出第一个 OAuth 请求的全部流程了 按需选择适配模块让 Signpost 适配你的 HTTP 栈 不同 HTTP 库对应不同的 Consumer 实现只需换一行构造代码Apache Commons HTTP 4.x推荐也适合 AndroidOAuthConsumer consumer new CommonsHttpOAuthConsumer(CONSUMER_KEY, CONSUMER_SECRET); HttpGet request new HttpGet(http://example.com/protected); consumer.sign(request);Jetty 6.xOAuthConsumer consumer new JettyOAuthConsumer(CONSUMER_KEY, CONSUMER_SECRET);各模块的使用示例详见项目内文档docs/ApacheCommonsHttp4.md、docs/JettyHttp6.md。避坑清单新手最常踩的 4 个坑 ⚠️坑说明解法POST 带表单参数签名失败HttpURLConnection基于流式写入Signpost 无法在发送前读取 body 参与签名改用 Commons HTTP 4.x 及signpost-commonshttp4模块Android 上签名异常Android 的HttpURLConnection存在已知 BugAndroid 一律使用CommonsHttpOAuthConsumer多线程共享对象Signpost不是线程安全的每个线程创建独立的 Consumer/Provider 实例两者都很轻量且支持序列化持久化获取 Token 时返回 401应用未在服务方注册为可接收回调在服务方后台登记你的回调地址延伸阅读 完整上手指南docs/GettingStarted.md支持的 HTTP 库清单docs/SupportedHttpLibraries.md以 Twitter 为例的完整实战流程docs/TwitterAndSignpost.md版本变更记录CHANGELOG.md核心接口定义signpost-core/src/main/java/oauth/signpost/OAuthConsumer.java、signpost-core/src/main/java/oauth/signpost/OAuthProvider.java签名算法实现目录signpost-core/src/main/java/oauth/signpost/signature/Signpost 坚持简单至上用最小的 API 覆盖 OAuth 签名的全部刚需。对于大多数 Java 应用来说这几行代码就足以安全地接入任意支持 OAuth 1.0a 的服务。【免费下载链接】signpostA light-weight client-side OAuth library for Java项目地址: https://gitcode.com/gh_mirrors/si/signpost创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考