У меня есть несколько сценариев, использующих функции, находящиеся в модуле (psm1). У меня также есть общие значения (пути/имена файлов), которые в настоящее время находятся в глобальных хеш-таблицах модуля. MS сейчас не поощряет глобальные объекты, поэтому я пытаюсь найти способ включить свои значения в модуль, а не использовать другой файл (XML, CSV и т. д.) и не помещать их в каждый скрипт. Когда что-то изменится (а это произойдет), я хочу просто обновиться в одном месте — в моем модуле.
Есть идеи относительно глобально доступного «словаря»/хеш-таблицы значений, которые можно поместить в модуль, а затем импортировать, когда я импортирую модуль в начале каждого сценария? Я импортирую модуль с параметром -global, но без указания глобальных хэш-таблиц значения не сохраняются. Функции в порядке (по дизайну).
PSSharper выдает предупреждения о глобальных переменных, объектах, хеш-таблицах и т. д. PS ScriptAnalyzer вызывает глобальные хеш-таблицы, а многочисленные статьи MS препятствуют глобальному использованию.
ТИА
Я не знаю ничего, что мешало бы вам предоставлять функции глобально, а функции могут предоставлять данные, например возвращать словарь или хеш-таблицу. Поскольку вы передаете ссылку на объект, любые изменения объекта станут доступны любому другому коду, который запрашивает ту же функцию для этого объекта. Но если мы говорим о нескольких потоках, работающих одновременно, возможно, вам стоит поискать потокобезопасные Параллельные коллекции.
Ваш вопрос предполагает, что вы загружаете свои сценарии в область модуля, используя точечный источник. Любая переменная, определенная в корне скрипта, будет настолько глобальной, насколько это возможно. (Кроме того, вы можете обмануть PSScriptAnalyzer bij, используя Set-Variable -Scope Global
). Однако возникает вопрос: действительно ли вы хотите, чтобы эти сценарии могли мешать друг другу (какой из ваших сценариев является основным и имеет контроль над определением глобальной переменной $GlobalConfig = @{}
?). См. #18740 Рекомендация: импорт функций в модуле
Говоря это, я полагаю, что инициализация $GlobalConfig = @{}
должна идти непосредственно в файл вашего модуля (.psm1) , и если вы также хотите выставить его за пределами модуля, вам нужно добавить это к VariablesToExport
в манифесте модуля ..
Вероятно, у меня есть для вас решение, основанное на размещении переменных в области видимости модуля. Он основан на этой публикации в блоге
Вы создаете переменную в области модуля и помещаете в нее все необходимое для работы модуля:
$DynDnsSession = [ordered]@{
ClientUrl = 'https://api.dynect.net'
ApiVersion = $null
AuthToken = $null
StartTime = $null
RefreshTime = $null
}
New-Variable -Name DynDnsSession -Value $DynDnsSession -Scope Script -Force
Поскольку переменная будет определена в области модуля, у вас не будет возможности изменить ее, напрямую обращаясь к ней из ваших скриптов — вам нужны оболочки (геттер и установщик) для этой переменной внутри вашего модуля.
Например (это весь модуль .psm1
; на основе того же поста в блоге)
$DynDnsSession = [ordered]@{
ClientUrl = 'https://api.dynect.net'
ApiVersion = $null
AuthToken = $null
StartTime = $null
RefreshTime = $null
}
Function Get-DynDnsSession {
return $DynDnsSession
}
Function Set-DynDnsSession {
[CmdletBinding()]
param(
)
DynamicParam {
# define dictionary for dynamic parameters
$ParamDictionary = [System.Management.Automation.RuntimeDefinedParameterDictionary]::new()
# get all the keys from the module variable; please note the .GetEnumerator()
# it's to separate properties from each other, otherwise you just get all the values as a single object and not an array
$DynProps = $DynDnsSession.Keys.GetEnumerator()
foreach ($Prop in $DynProps) {
# type of the attribute. You probably can base this
# on the type of variables you have in your dictionary
$AttrType = "String"
$AttrCollection = [System.Collections.ObjectModel.Collection[System.Attribute]]::new()
$ParamAttr = [System.Management.Automation.ParameterAttribute]@{
ParameterSetName = "DynamicFields"
Mandatory = $false
HelpMessage = $Prop # you can define this with a switch based on a property name if you want to
}
$AttrCollection.Add($ParamAttr)
$DynParam = [System.Management.Automation.RuntimeDefinedParameter]::new(
$Prop, $AttrType, $AttrCollection
)
$ParamDictionary.Add($Prop, $DynParam)
}
return $ParamDictionary
}
PROCESS {
foreach ($Param in $PSBoundParameters.GetEnumerator()) {
if ($DynDnsSession.Contains($Param.Key)) {
Write-Output $Param
Write-Verbose "Setting $($Param.Key) to $($Param.Value)" -Verbose
$DynDnsSession.$($Param.Key) = $Param.Value
}
}
}
}
Я также определил динамические параметры для проверки того, что вы хотите установить. Но если вы хотите добавить или удалить свойства из этой переменной модуля, вам придется использовать другой подход (хотя он будет проще, чем DynamicParam). Я без проблем использую это в своих нескольких модулях RestAPI, и PSScriptAnalyzer никогда не жаловался.
DynamicParam основан на этом посте.
Это сработает. Поскольку значения не изменятся, пока я не внесу изменения в местоположения/значения в модуле, на данный момент это лучшее решение. Для тех, кто спрашивает выше, сценарии предназначены для подключения новых пользователей к Active Directory, Hybrid Exchange и Azure/Entra. Я работаю в кадровой компании, поэтому у нас есть несколько типов учетных записей пользователей: сотрудники, внутренние консультанты, внешние консультанты и места размещения. Я работал над этими скриптами более 4 лет и сейчас приступил к их рефакторингу по просьбе моего директора. И когда я уйду на пенсию, мне придется передать их коллеге. =)
Вы можете определить переменные области действия на уровне модуля. Например:
$Script:WordList = 'cat', 'dog'
А затем ссылайтесь на эту переменную во всех функциях вашего модуля:
$Script:WordList
Являются ли эти переменные общедоступными (доступными конечному пользователю) или только функциями вашего модуля? Переменные, определенные в вашем psm1, не перезаписываются, если вы не используете
Import-Module -Force
, поэтому ваш вопрос неясен и требует более подробной информации/воспроизводимого примера.