microsoftgraph / microsoftgraph/msgraph-sdk-java

Improve v6 for better Generics usage

未关闭
#2,320 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

status:waiting-for-triage type:feature
主要语言
Java
星标
444
派生
154
平均合并
18 小时 28 分钟
30 天内合并 PR
4

描述

Is your feature request related to a problem? Please describe the problem.

We are trying to use v6 with generic methods to reduce duplicate boiler plate code, but struggle to do this efficiently. We struggled with the following:

  1. GetRequestConfiguration
    This class seems to be part of each Builder class and there is not one abstract parent implementation for all Builder classes. We can't write a generic method handling each entity because there are hundreds of seperate GetRequestConfiguration implementations, e.g. one for UsersRequestBuilder and this method now can only be used for UsersRequestBuilder:
public static Consumer<UsersRequestBuilder.GetRequestConfiguration> addAdvancedQueryCapabilities() {
		return cust -> {
			Objects.requireNonNull(cust.queryParameters).count = true;
			cust.headers.add("ConsistencyLevel", "eventual");
		};
	}

The same applies for PostRequestConfiguration and all other classes.

  1. BaseCollectionPaginationCountResponse
    Here we see some problems:
  • This class is not typed at all. In v5 there is a generic return type of the response class which determines the correct class for the actual item values in the page collection.
  • After the typing you could add getValue to the base class and not implement it in each subclass which should help to determine the actual return type in v6 as well.
  • Also we think as improvement createFromDiscriminatorValue should be overwritten in each subclass with it's correct implementation (I think this is already done), but we don't understand why we have the need to manually pass the correct descriminator to the PageIterator. We believe this can be done automatically without manual interaction.

Our call currently looks like this using a similar PageIterator as seen in here:

UserCollectionResponse page = userCollectionRequest.get(customizer);
List<User> users = RequestUtils.collectListFromAllPages(this.graphClient.getGraphServiceClient(), page,
	UserCollectionResponse::createFromDiscriminatorValue, this.getClass());

We already pass a UserCollectionResponse but we don't understand why the PageIterator does not get it's discriminator automatically and we have to set it manually by passing the explicit discriminator.

Also we can't use var users = ..., because we need to declare the return type as Entity and can't get it from UserCollectionResponse since that class is not typed.

What do you think about this?

Describe the solution you'd like.

For 1)
Use interfaces for the Configurators, such that generic implementations can be done using these interfaces.

For 2:
Already proposed above

Additional context?

No response

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先阅读各个 Builder 类中的 GetRequestConfiguration 实现,然后检查 BaseCollectionPaginationCountResponse、UserCollectionResponse 以及 PageIterator 的使用情况。Issue 提议的结果是支持通用配置器、类型化的集合响应,并减少手动处理 discriminator;未指定具体文件或测试。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
api
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。