4PointSolutions / 4PointSolutions/FormsFeeder

Create supporting framework for parsing plugin input parameters

オープン
#13 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
4
フォーク
3
PR マージ指標
30日以内にマージされた PR はありません

説明

Currently, the parsing of inputs to a plugin is always ad-hoc code. This leads to a lot of code duplication and is an impediment to easily creating plugins. It would be nice if there was a declarative approach that could be used instead.

I am thinking of a Builder pattern where one builds a list of input parameters that one expects. Each parameter would have a name, whether it repeats, whether it is optional and a class type. The result would be used by the framework code to decode the input parameters into a result object (the decoded InputParameters object).

Ideally the result object would ideally allow the user to access individual outputs in a strongly typed fashion, however in the worst case scenario, perhaps it could be a Map keyed in each input parameters name.

Another idea would be for the caller to pass in a Java record class that the parsing routine would examine using reflection and use it to get the Input parameters and populate the Record. Each field's name would be used to retrieve parameters. If the field was an Optional<> this would indicate that the parameter was optional. If the field was a Collection of some sort, that would indicate that the parameter could repeat.

A precursor to this is probably implementing issue #12 .

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

First, examine existing plugin implementations to understand the current ad-hoc parsing. Review issue #12 as a precursor. The goal is to design a builder pattern or reflection-based system for declarative input parameter parsing. Start by exploring the plugin interface and how inputs are currently passed. A successful implementation will reduce code duplication and be used by plugin authors.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
backend-api-design
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。