akka/akka-http

Split package `akka.http.ccompat`

Open

#2,902 建立於 2020年1月20日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Scala (1,311 star) (598 fork)batch import
1 - triagedbinary-incompatiblediscusshelp wantednice-to-have (low-prio)

描述

This is a follow-up to https://github.com/akka/akka/issues/28304#issuecomment-576360895.

The two artifacts akka.parsing and akka.http.core. both in version 10.1.11, contain (disjunct) classes in the Java package akka.http.ccompat. A split package is considered bad practice, even in plain Java world. Split packages are even not possible when working with sealed packages/jars.

As we currently review the OSGi support for akka and akka-http in a separate project (as a consequence of https://github.com/akka/akka/issues/28304), we wanted to ask the purpose of the found split package. If this is "by accident", I'd like to propose one of the following fixes:

  1. Move all classes to the same package into the same artifact
  2. Rename one of the packages to avoid the split-package issue, preferably choosing a package name which shares the artifact name as it's prefix
  3. Keep it as-is. I think this way should be avoided, but could be necessary e.g. when the packages are part of a public API. But even then, maybe 1. will also work.

Related to https://github.com/woq-blended/akka-osgi/issues/1

貢獻者指南

技術棧
java
領域
backend
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Scala/Java knowledgeJava package naming conventions
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Investigate the classes under akka.http.ccompat in both akka parsing and akka http core artifacts. Determine if they can be merged into one artifact or if renaming is appropriate. Look at the related issue #28304 and the OSGi discussion for context. Choose among the three proposed fixes and implement the change.